-
-
Notifications
You must be signed in to change notification settings - Fork 163
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
Fix typos/mistakes/wording/links in documentation/comments #1152
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop/v2 #1152 +/- ##
==============================================
+ Coverage 72.00% 75.61% +3.61%
==============================================
Files 93 96 +3
Lines 13795 12008 -1787
==============================================
- Hits 9933 9080 -853
+ Misses 3044 2109 -935
- Partials 818 819 +1 ☔ View full report in Codecov by Sentry. |
Thank you for taking the time to do this. There were certainly more typos than I had hoped for. One request for future PRs, though: Please make them shorter, and make them against a single topic. For example a single PR on |
I'm sorry, I kind of dumped everything in this branch whenever I encountered something (and eventually I just went through most of the files I had opened and noted things here). I must have seen the few places that used the |
Change pre-existing use of "sub-option" to "suboption".
thanks! |
This fixes some typos/mistakes I found in the documentation and code comments. It also changes some wording to try and make their meaning more clear. Lastly it also fixes broken links and removes non-existent links.
I'm not entirely sure about the links. I fixed some broken links, I removed some that had no clear use case (links in table of content with no (sub-)title that matched it), I changed some links that were pointing to non-existent FAQs and pointed them to a similar FAQ. This might need special attention while reviewing.