docs(typing): snippets split, improved, and lint #1465
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
leandrodamascena
requested review from
rubenfonseca
and removed request for
a team
boring-cyborg
bot
added
the
documentation
pull-request-size
bot
added
the
size/M
rubenfonseca
suggested changes
Aug 22, 2022
rubenfonseca
approved these changes
Aug 24, 2022
Co-authored-by: Ruben Fonseca <[email protected]>
heitorlessa
reviewed
Aug 25, 2022
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.
Issue number: #1453
Summary
Changes
Changes snippet fictitious names to real code snippet filenames for easier discovery and collaboration to improve/correct document snippets.
Some examples have also been refactored so that the codes are complete and there are no lint/pre-commit hooks issues.
User experience
Before:
After:
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number:
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
View rendered docs/utilities/typing.md