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.

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

Docs: fix documention deep links #11233

Merged
merged 2 commits into from
Dec 21, 2022
Merged

Docs: fix documention deep links #11233

merged 2 commits into from
Dec 21, 2022

Conversation

cafferata
Copy link
Contributor

Following the Composer 2.5 release, I presented the interactive prompt run script #11157 to colleagues. In addition, I found that the deep links to the documentation website do not work properly.

Initially searched within src/Composer/Command, after that a refinement of the entire project.

Before/after (diff)

composer run-script --help
Description:
  Runs the scripts defined in composer.json

Usage:
  run-script [options] [--] [<script> [<args>...]]
  run

Arguments:
  script                         Script name to run.
  args

Options:
      --timeout=TIMEOUT          Sets script timeout in seconds, or 0 for never.
      --dev                      Sets the dev mode.
      --no-dev                   Disables the dev mode.
  -l, --list                     List scripts.
  -h, --help                     Display help for the given command. When no command is given display help for the list command
  -q, --quiet                    Do not output any message
  -V, --version                  Display this application version
      --ansi|--no-ansi           Force (or disable --no-ansi) ANSI output
  -n, --no-interaction           Do not ask any interactive question
      --profile                  Display timing and memory usage information
      --no-plugins               Whether to disable plugins.
      --no-scripts               Skips the execution of all scripts defined in composer.json file.
  -d, --working-dir=WORKING-DIR  If specified, use the given directory as working directory.
      --no-cache                 Prevent use of the cache
  -v|vv|vvv, --verbose           Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
  The run-script command runs scripts defined in composer.json:

  php composer.phar run-script post-update-cmd

- Read more at https://getcomposer.org/doc/03-cli.md#run-script
+ Read more at https://getcomposer.org/doc/03-cli.md#run-script-run

@Seldaek Seldaek added this to the 2.5 milestone Dec 21, 2022
@Seldaek Seldaek added the Bug label Dec 21, 2022
@Seldaek Seldaek merged commit da611e0 into composer:main Dec 21, 2022
@Seldaek
Copy link
Member

Seldaek commented Dec 21, 2022

Thanks!

@cafferata cafferata deleted the docs-fix-documention-deep-links branch December 21, 2022 09:51
emahorvat52 pushed a commit to emahorvat52/composer that referenced this pull request Feb 3, 2023
* Docs: Fixed the deep links to the documentation website.

Search scope: `src/Composer/Command`.

* Docs: Fixed the deep links to the documentation website.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants