8000 Add ReStructuredText descriptor for console component. by grasmash · Pull Request #45718 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

Add ReStructuredText descriptor for console component. #45718

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 12 commits into from
Closed

Add ReStructuredText descriptor for console component. #45718

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9990248
Add ReStructuredText descriptor for console component.
grasmash Mar 11, 2022
a3dd64a
Fix up.
grasmash Mar 11, 2022
3044d77
Add fixture placeholders.
grasmash Mar 11, 2022
ca7843a
Fix PHPCS issues.
grasmash Mar 11, 2022
ac5e84c
Add rst fixtures.
grasmash Mar 11, 2022
f0ba4f4
Fix fixtures.
grasmash Mar 11, 2022
f43d953
Fix string.
grasmash Mar 11, 2022
7d33e75
Fix paths.
grasmash Mar 11, 2022
9b76f9d
Add to helper.
grasmash Mar 11, 2022
a071663
Tests
grasmash Mar 11, 2022
728e356
Update fixtures again.
grasmash Mar 11, 2022
11c8f25
Last.
grasmash Mar 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix fixtures.
  • Loading branch information
@grasmash
grasmash committed Mar 11, 2022
commit f0ba4f4e5859d0eae0c40916243bc46e91e0047b
2 changes: 1 addition & 1 deletion src/Symfony/Component/Console/Tests/Fixtures/application_1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Dynamic installation

Add this to the end of your shell configuration file (e.g. "~/.bashrc"):

eval "$(/Users/matt.grasmick/Sites/projects/symfony/phpunit completion bash)"
eval "$(/Users/matt.grasmick/Sites/projects/symfony-framework/phpunit completion bash)"

Arguments
=========
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Console/Tests/Fixtures/application_2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Dynamic installation

Add this to the end of your shell configuration file (e.g. "~/.bashrc"):

eval "$(/Users/matt.grasmick/Sites/projects/symfony/phpunit completion bash)"
eval "$(%%PHP_SELF_FULL%% completion bash)"

Arguments
=========
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Console/Tests/Fixtures/application_mbstring.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Dynamic installation

Add this to the end of your shell configuration file (e.g. "~/.bashrc"):

eval "$(/Users/matt.grasmick/Sites/projects/symfony/phpunit completion bash)"
eval "$(%%PHP_SELF_FULL%% completion bash)"

Arguments
=========
Expand Down
17 changes: 11 additions & 6 deletions src/Symfony/Component/Console/Tests/Fixtures/command_1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
`descriptor:command1`
---------------------
.. _alias1:

.. _alias2:

``descriptor:command1``
***********************

command 1 description

### Usage
Usage
=====

* `descriptor:command1`
* `alias1`
* `alias2`
- ``descriptor:command1``
- ``alias1``
- ``alias2``

command 1 help
41 changes: 23 additions & 18 deletions src/Symfony/Component/Console/Tests/Fixtures/command_2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,35 @@
`descriptor:command2`
---------------------
``descriptor:command2``
***********************

command 2 description

### Usage
Usage
=====

* `descriptor:command2 [-o|--option_name] [--] <argument_name>`
* `descriptor:command2 -o|--option_name <argument_name>`
* `descriptor:command2 <argument_name>`
- ``descriptor:command2 [-o|--option_name] [--] <argument_name>``
- ``descriptor:command2 -o|--option_name <argument_name>``
- ``descriptor:command2 <argument_name>``

command 2 help

### Arguments
Arguments
=========

#### `argument_name`
``argument_name``
-----------------

* Is required: yes
* Is array: no
* Default: `NULL`
- Is required: yes
- Is array: no
- Default: ``NULL``

### Options
Options
=======

#### `--option_name|-o`
``--option_name|-o``
--------------------

* Accept value: no
* Is value required: no
* Is multiple: no
* Is negatable: no
* Default: `false`
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default: ``false``
41 changes: 23 additions & 18 deletions src/Symfony/Component/Console/Tests/Fixtures/command_mbstring.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,35 @@
`descriptor:åèä`
----------------
``descriptor:åèä``
******************

command åèä description

### Usage
Usage
=====

* `descriptor:åèä [-o|--option_åèä] [--] <argument_åèä>`
* `descriptor:åèä -o|--option_name <argument_name>`
* `descriptor:åèä <argument_name>`
- ``descriptor:åèä [-o|--option_åèä] [--] <argument_åèä>``
- ``descriptor:åèä -o|--option_name <argument_name>``
- ``descriptor:åèä <argument_name>``

command åèä help

### Arguments
Arguments
=========

#### `argument_åèä`
``argument_åèä``
----------------

* Is required: yes
* Is array: no
* Default: `NULL`
- Is required: yes
- Is array: no
- Default: ``NULL``

### Options
Options
=======

#### `--option_åèä|-o`
``--option_åèä|-o``
-------------------

* Accept value: no
* Is value required: no
* Is multiple: no
* Is negatable: no
* Default: `false`
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default: ``false``
9 changes: 5 additions & 4 deletions src/Symfony/Component/Console/Tests/Fixtures/input_argument_1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#### `argument_name`
``argument_name``
-----------------

* Is required: yes
* Is array: no
* Default: `NULL`
- Is required: yes
- Is array: no
- Default: ``NULL``
9 changes: 5 additions & 4 deletions src/Symfony/Component/Console/Tests/Fixtures/input_argument_2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
#### `argument_name`
``argument_name``
-----------------

argument description

* Is required: no
* Is array: yes
* Default: `array ()`
- Is required: no
- Is array: yes
- Default: ``array ()``
9 changes: 5 additions & 4 deletions src/Symfony/Component/Console/Tests/Fixtures/input_argument_3.rst
View file
Open in desktop
52ED
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
#### `argument_name`
``argument_name``
-----------------

argument description

* Is required: no
* Is array: no
* Default: `'default_value'`
- Is required: no
- Is array: no
- Default: ``'default_value'``
9 changes: 5 additions & 4 deletions src/Symfony/Component/Console/Tests/Fixtures/input_argument_4.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
#### `argument_name`
``argument_name``
-----------------

multiline
argument description

* Is required: yes
* Is array: no
* Default: `NULL`
- Is required: yes
- Is array: no
- Default: ``NULL``
9 changes: 5 additions & 4 deletions ...fony/Component/Console/Tests/Fixtures/input_argument_with_default_inf_value.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
#### `argument_name`
``argument_name``
-----------------

argument description

* Is required: no
* Is array: no
* Default: `INF`
- Is required: no
- Is array: no
- Default: ``INF``
9 changes: 5 additions & 4 deletions src/Symfony/Component/Console/Tests/Fixtures/input_argument_with_style.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
#### `argument_name`
``argument_name``
-----------------

argument description

* Is required: no
* Is array: no
* Default: `'style'`
- Is required: no
- Is array: no
- Default: ``'style'``
12 changes: 7 additions & 5 deletions src/Symfony/Component/Console/Tests/Fixtures/input_definition_2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
### Arguments
Arguments
=========

#### `argument_name`
``argument_name``
-----------------

* Is required: yes
* Is array: no
* Default: `NULL`
- Is required: yes
- Is array: no
- Default: ``NULL``
16 changes: 9 additions & 7 deletions src/Symfony/Component/Console/Tests/Fixtures/input_definition_3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
### Options
Options
=======

#### `--option_name|-o`
``--option_name|-o``
--------------------

* Accept value: no
* Is value required: no
* Is multiple: no
* Is negatable: no
* Default: `false`
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default: ``false``
28 changes: 16 additions & 12 deletions src/Symfony/Component/Console/Tests/Fixtures/input_definition_4.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
### Arguments
Arguments
=========

#### `argument_name`
``argument_name``
-----------------

* Is required: yes
* Is array: no
* Default: `NULL`
- Is required: yes
- Is array: no
- Default: ``NULL``

### Options
Options
=======

#### `--option_name|-o`
``--option_name|-o``
--------------------

* Accept value: no
* Is value required: no
* Is multiple: no
* Is negatable: no
* Default: `false`
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default: ``false``
13 changes: 7 additions & 6 deletions src/Symfony/Component/Console/Tests/Fixtures/input_option_1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
#### `--option_name|-o`
``--option_name|-o``
--------------------

* Accept value: no
* Is value required: no
* Is multiple: no
* Is negatable: no
* Default: `false`
- Accept value: no
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default: ``false``
13 changes: 7 additions & 6 deletions src/Symfony/Component/Console/Tests/Fixtures/input_option_2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
#### `--option_name|-o`
``--option_name|-o``
--------------------

option description

* Accept value: yes
* Is value required: no
* Is multiple: no
* Is negatable: no
* Default: `'default_value'`
- Accept value: yes
- Is value required: no
- Is multiple: no
- Is negatable: no
- Default: ``'default_value'``
13 changes: 7 additions & 6 deletions src/Symfony/Component/Console/Tests/Fixtures/input_option_3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
#### `--option_name|-o`
``--option_name|-o``
--------------------

option description

* Accept value: yes
* Is value required: yes
* Is multiple: no
* Is negatable: no
* Default: `NULL`
- Accept value: yes
- Is value required: yes
- Is multiple: no
- Is negatable: no
- Default: ``NULL``
13 changes: 7 additions & 6 deletions src/Symfony/Component/Console/Tests/Fixtures/input_option_4.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
#### `--option_name|-o`
``--option_name|-o``
--------------------

option description

* Accept value: yes
* Is value required: no
* Is multiple: yes
* Is negatable: no
* Default: `array ()`
- Accept value: yes
- Is value required: no
- Is multiple: yes
- Is negatable: no
- Default: ``array ()``
13 changes: 7 additions & 6 deletions src/Symfony/Component/Console/Tests/Fixtures/input_option_5.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
#### `--option_name|-o`
``--option_name|-o``
--------------------

multiline
option description

* Accept value: yes
* Is value required: yes
* Is multiple: no
* Is negatable: no
* Default: `NULL`
- Accept value: yes
- Is value required: yes
- Is multiple: no
- Is negatable: no
- Default: ``NULL``
Loading
0