msgraph-cli icon indicating copy to clipboard operation
msgraph-cli copied to clipboard

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

Open MIchaelMainer opened this issue 2 years ago • 0 comments

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.

MIchaelMainer avatar Sep 27 '23 20:09 MIchaelMainer