-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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
style-guide: add grouping documentation #15773
base: main
Are you sure you want to change the base?
Conversation
I'm asking for feedback if this should be documented. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that it makes sense to document this
|
||
Sometimes commands and subcommands are single use but are meant to be used in combination with other commands. In these cases it makes sense to move them on the same page. | ||
|
||
For example `adb disconnect` has a single way using it, but `adb` is expansive enough that it doesn't fit in the main page. Normally `adb disconnect` is used in combination with `adb pair` and `adb connect`, thus it makes sense to group these together into a single page. For example: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For example `adb disconnect` has a single way using it, but `adb` is expansive enough that it doesn't fit in the main page. Normally `adb disconnect` is used in combination with `adb pair` and `adb connect`, thus it makes sense to group these together into a single page. For example: | |
For example `adb disconnect` has a single way using it, but `adb` is expansive enough that it doesn't fit in the main page. Normally, `adb disconnect` is used in combination with `adb pair` and `adb connect`, thus it makes sense to group these together into a single page. For example: |
@@ -226,6 +226,22 @@ In the following case `just.md` is the filename of the disambiguation page while | |||
`tldr just.js` | |||
``` | |||
|
|||
### Grouping commands | |||
|
|||
Sometimes commands and subcommands are single use but are meant to be used in combination with other commands. In these cases it makes sense to move them on the same page. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sometimes commands and subcommands are single use but are meant to be used in combination with other commands. In these cases it makes sense to move them on the same page. | |
Sometimes commands are meant to be used in combination with other commands. In these cases it makes sense to move them on the same page. |
common
,linux
,osx
,windows
,sunos
,android
, etc.