Skip to content

Commit

Permalink
Merge pull request #325 from jolicode/doc-run-path
Browse files Browse the repository at this point in the history
Replace path argument occurences in run() documentation
  • Loading branch information
lyrixx committed Mar 13, 2024
2 parents 555c0f1 + 80c82c1 commit 4876c42
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/getting-started/run.md
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

0 comments on commit 4876c42

Please sign in to comment.