Provide more detail to the output of --help #24
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…-models into jessrudder/update-help-message
cschleiden
reviewed
Oct 17, 2024
cheshire137
reviewed
Oct 17, 2024
Member
cheshire137
left a comment
cheshire137
left a comment
There was a problem hiding this comment.
I agree with Christopher about dropping the API request mentions.
Co-authored-by: Sarah Vessels <82317+cheshire137@users.noreply.github.com>
Co-authored-by: Sarah Vessels <82317+cheshire137@users.noreply.github.com>
Co-authored-by: Sarah Vessels <82317+cheshire137@users.noreply.github.com>
Co-authored-by: Sarah Vessels <82317+cheshire137@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes https://github.com/github/models/issues/321
This PR updates the
--helpoutput for the following:gh models --helpgh models list --helpgh models view --helpgh models run --helpIn order to make it easier to format the longer string I've included the heredoc module.
The contents that I wrote are a rough draft based on my basic understanding of how things work and what's helpful to include in the docs. Please provide feedback on the content!
Some specific points I'd like feedback on (though all feedback is welcome):
Should we mention Azure at all (also, am I even correct that this is coming from Azure)?Consensus is no.I followed some other gh CLIs and mentioned https://cli.github.com/manual/gh_models - will we actually have docs there (like codespace and other extensions do)?Using the readme for the extension for now, can change later if we end up in the online manual.