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

[V1 RC Bug Bash]: Nitpick on help formatting and find more info here #350

Open
MIchaelMainer opened this issue Sep 27, 2023 · 0 comments
Open
Labels
documentation Improvements or additions to documentation User Experience Enhancement

Comments

@MIchaelMainer
Copy link
Contributor

MIchaelMainer commented Sep 27, 2023

Consider appending the Find more info here: to the description. Suggestion is to go from:

Original layout

  create                                                    Create a new user object.

                                                            Find more info here:
                                                              https://learn.microsoft.com/graph/api/intune-onboarding-user-create?view=graph-rest-1.0
  list                                                      List properties and relationships of the user objects.

                                                            Find more info here:
                                                              https://learn.microsoft.com/graph/api/intune-mam-user-list?view=graph-rest-1.0
  delete                                                    Deletes a user.

                                                            Find more info here:
                                                              https://learn.microsoft.com/graph/api/intune-onboarding-user-delete?view=graph-rest-1.0

to the following below. Note that there are two styles to consider. Also note that since we have some long command names, it makes a somewhat challenging to match command with description.

Improved layout

  create                                                    Create a new user object. Find more info here:
                                                              https://learn.microsoft.com/graph/api/intune-onboarding-user-create?view=graph-rest-1.0
  list                                                      List properties and relationships of the user objects. Find more info here:
                                                              https://learn.microsoft.com/graph/api/intune-mam-user-list?view=graph-rest-1.0
  delete                                                    Deletes a user.
                                                              Find more info here:
                                                              https://learn.microsoft.com/graph/api/intune-onboarding-user-delete?view=graph-rest-1.0

Screen capture from terminal
CLI help formatting

I think I see why this is. It is optimized for viewing the documentation for a single command, not a list.

@calebkiage calebkiage added documentation Improvements or additions to documentation User Experience Enhancement labels Oct 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation User Experience Enhancement
Projects
None yet
Development

No branches or pull requests

2 participants