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 generation for example usage mangles descriptive text #2559

Open
NReilingh opened this issue Mar 11, 2024 · 0 comments
Open

Docs generation for example usage mangles descriptive text #2559

NReilingh opened this issue Mar 11, 2024 · 0 comments

Comments

@NReilingh
Copy link
Contributor

Expected behavior

Actual behavior

  • The descriptive text from each usage example only contains the first line of text from the source code, truncating any subsequent lines.

Additional information

Source code for this command

* @usage <site>.<env> <target_env> Clones database and files from <site>'s
* <env> environment to <target_env> environment.
* @usage <site>.<env> <target_env> --cc Clones from <site>'s <env>
* environment to <target_env> environment and clears the cache.
* @usage <site>.<env> <target_env> --db-only Clones only the database from
* <site>'s <env> environment to <target_env> environment.
* @usage <site>.<env> <target_env> --files-only Clones only files from
* <site>'s <env> environment to <target_env> environment.
* @usage <site>.<env> <target_env> --updatedb Clones from <site>'s <env>
* environment to <target_env> environment and updates the Drupal
* database (if applicable).
* @usage <site>.<env> <target_env> --from-url=www.example.com
* --to-url=mulitidevenv.example.com (WordPress only) Clones from
* <site>'s <env> environment to <target_env> environment and replaces
* www.example.com with mulitidevenv.example.com in the database.

Truncated usage examples as displayed on docs website

screenshot of docs website for this command

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant