Skip to content

Commit

Permalink
Merge pull request #350 from jolicode/autocomplete-doc-tweak
Browse files Browse the repository at this point in the history
Tweak the autocomplete documentation
  • Loading branch information
pyrech authored Mar 28, 2024
2 parents 5b4adf1 + 4ab660c commit fe4e56d
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ etc., but it leverages PHP's scripting capabilities and its extensive library ec
It comes with many features to make your life easier:

* Seamless parsing of **arguments and options**, simplifying input handling
* **Autocomplete** support for faster and error-free typing
* **[Autocomplete](https://castor.jolicode.com/going-further/interacting-with-castor/autocomplete)** support for faster and error-free typing
* A built-in list of useful functions:
* [`run()`](https://castor.jolicode.com/getting-started/run/#the-run-function): Runs external processes, enabling seamless integration with external tools
* [`parallel()`](https://castor.jolicode.com/going-further/helpers/parallel/#the-parallel-function): Parallelizes process execution to maximize resource utilization
Expand Down
3 changes: 2 additions & 1 deletion doc/going-further/interacting-with-castor/autocomplete.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ castor completion --help

## Autocomplete arguments

You have to options to make your arguments autocompleted.
You have two options to make your arguments autocompleted.

### Static suggestions

Expand Down Expand Up @@ -78,6 +78,7 @@ function get_argument_autocompletion(CompletionInput $input): array
>[!NOTE]
> Because the syntax `my_callback(...)` is not allowed on attribute, you need to
> specify the `autocomplete` callback with either:
>
> - the string syntax (`my_namespace\my_function` or `'MyNamespace\MyClass::myFunction'`)
> - the array syntax (`['MyNamespace\MyClass', 'myFunction']`).
Expand Down
2 changes: 1 addition & 1 deletion doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ etc., but it leverages PHP's scripting capabilities and its extensive library ec
It comes with many features to make your life easier:

* Seamless parsing of **arguments and options**, simplifying input handling
* **Autocomplete** support for faster and error-free typing
* **[Autocomplete](going-further/interacting-with-castor/autocomplete.md)** support for faster and error-free typing
* A built-in list of useful functions:
* [`run()`](getting-started/run.md#the-run-function): Runs external processes, enabling seamless integration with external tools
* [`parallel()`](going-further/helpers/parallel.md#the-parallel-function): Parallelizes process execution to maximize resource utilization
Expand Down

0 comments on commit fe4e56d

Please sign in to comment.