[docs] Improve the update_file docs #513
Merged
Conversation
This file contains 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
This is a documentation-only commit. It updates the docs for the update_file function to explain what the different parameters do and adds a hyperlink to the GitHub API docs
|
Thank you for your PR, and congrats on your first contribution! 🎉 |
Merged
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.
This is a documentation-only commit. It updates the docs for the update_file function to explain what the different parameters do and adds a hyperlink to the GitHub API docs.
I was using
octocrabbut it wasn't clear what theshaparameter was, and why I'd need to provide a file SHA if I'm already giving the path of the file I want to update. I did some digging to figure out the reason, so I thought I'd update the docs to explain this for future travellers.