Parameters at the end in documentation, for better discoverability and legibility

Created on 8 October 2019, over 4 years ago
Updated 31 January 2023, over 1 year ago

I have noticed that the Composer-Ready Project Templates documentation inserts the -n (--no-interaction) parameter between composer and create-project.

Now, if someone searches for "composer create-project" as a string (site:drupal.org "composer create-project") they will get some hits on drupal.org, whereas if they search for site:drupal.org "composer -n create-project" they would get hits for some other pages.

It also looks like "composer -n create-project" as a string is used fairly rarely anywhere:
https://www.google.com/search?q=%22composer+create-project%22 (133.000 results)
https://www.google.com/search?q=%22composer+-n+create-project%22 (86 results)

Is it worth considering streamlining parameters to accommodate discoverability? I suggest that they be put at the end of the line, since I also think it is more reader-friendly to have the "action" commands (composer + create-project) stand side-by-side, uninterrupted by parameters like -n and -s dev, for an uninterrupted syntax like this:

tool > command > what > where + parameters

Currently
composer -n create-project drupal/recommended-project my-project
Better?
composer create-project drupal/recommended-project my-project -n

πŸ“Œ Task
Status

Fixed

Version

10.1 ✨

Component
ComposerΒ  β†’

Last updated about 22 hours ago

No maintainer
Created by

πŸ‡©πŸ‡°Denmark ressa Copenhagen

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.69.0 2024