Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace path argument occurences in run() documentation #325

Merged
merged 1 commit into from Mar 13, 2024
Merged

Replace path argument occurences in run() documentation #325

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/getting-started/run.md
View file
Open in desktop
Expand Up @@ -66,8 +66,8 @@ function foo(): void
## Working directory

By default, Castor will execute the process in the same directory as
the `castor.php` file. You can change that by setting the `path` argument. It
can be either a relative or an absolute path:
the `castor.php` file. You can change that by setting the `currentDirectory`
argument. It can be either a relative or an absolute path:

```php
use Castor\Attribute\AsTask;
Expand All @@ -77,8 +77,8 @@ use function Castor\run;
#[AsTask()]
function foo(): void
{
run('pwd', path: '../'); // run the process in the parent directory of the castor.php file
run('pwd', path: '/tmp'); // run the process in the /tmp directory
run('pwd', currentDirectory: '../'); // run the process in the parent directory of the castor.php file
run('pwd', currentDirectory: '/tmp'); // run the process in the /tmp directory
}
```

Expand Down