-
-
Notifications
You must be signed in to change notification settings - Fork 797
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: clean up and improve documentation #1401
docs: clean up and improve documentation #1401
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1401 +/- ##
=======================================
Coverage 97.56% 97.56%
=======================================
Files 32 32
Lines 2132 2132
=======================================
Hits 2080 2080
Misses 52 52 ☔ View full report in Codecov by Sentry. |
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.
I'm not sure the single vs double back ticks makes a huge difference but I see you also made a bunch of other improvements, so thanks for this!
Thanks for merging! Actually, switching single backtick to double ones is my initial motivation to make this PR. While they are almost the same in source code text, it is rendered as italic and I think the later presentation improves the readability much better (also Before
After
|
Description of the Change
Hello, I've read through all the documentation pages and refactored them to have consistent markups. Also, fixed several errors during the proofreading.
All changes are documentation clean up so I combined the same kind of changes into each commit, but if you feel this PR contains too many changes, I can split this PR into small chunks. 🙂
Checklist
CHANGELOG.md
updated (only for user relevant changes)AUTHORS