-
Notifications
You must be signed in to change notification settings - Fork 421
docs(parameters): snippets split, improved, and lint #1564
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
docs(parameters): snippets split, improved, and lint #1564
Conversation
Codecov ReportBase: 97.51% // Head: 97.51% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## develop #1564 +/- ##
========================================
Coverage 97.51% 97.51%
========================================
Files 143 143
Lines 6570 6570
Branches 466 466
========================================
Hits 6407 6407
Misses 128 128
Partials 35 35 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
Signed-off-by: Leandro Damascena <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is amazing work @leandrodamascena thank you! I left some small comments but I ask you the following two things:
- can you please render the docs locally and manually check all the highlights to see if they make sense?
- can you rebase the branch with
develop
?
We should be able to merge this very soon
Hei Ruben! Thanks a lot for the feedback. I addressed all issues you mentioned and I moved 2 code snippet from |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work!
Issue number: #1368
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/parameters.md