Clean up doc/dev documentation files
#6195
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
optionsome
reviewed
Oct 27, 2024
Comment on lines
-126
to
+132
| 9. getter and setters | ||
| 8. `private`/package methods | ||
| 10. `private` enums (avoid `public`) | ||
| 11. interfaces | ||
| 12. `private static` classes (avoid `public`) | ||
| 13. instance classes (avoid) | ||
| 9. Getter and setters | ||
| 10. `private`/package methods | ||
| 11. `private` enums (avoid `public`) | ||
| 12. Interfaces | ||
| 13. `private static` classes (avoid `public`) | ||
| 14. Instance classes (avoid) |
There was a problem hiding this comment.
Looks like when I applied #6125 (comment), it somehow messed up the order numbers.
optionsome
reviewed
Oct 27, 2024
|
Thanks a lot for reading through the documentation and fixing all sorts of mistakes. I added a few comments after reading your suggestions. |
optionsome
previously approved these changes
Oct 29, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev-2.x #6195 +/- ##
=============================================
+ Coverage 69.91% 69.92% +0.01%
- Complexity 17727 17732 +5
=============================================
Files 1998 2000 +2
Lines 75452 75487 +35
Branches 7723 7727 +4
=============================================
+ Hits 52751 52788 +37
+ Misses 20022 20015 -7
- Partials 2679 2684 +5 ☔ View full report in Codecov by Sentry. |
abyrd
requested changes
Nov 1, 2024
abyrd
approved these changes
Nov 5, 2024
optionsome
approved these changes
Nov 5, 2024
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.
Summary
Cleans up miscellaneous typos, grammatical errors, style inconsistencies, etc. in documentation. This will improve readability for those accessing and referencing the docs, especially for new contributors.
There doesn't appear to be a formatter-enforced line length, so this PR uses 80 characters as that seems to be the loose consensus across other Markdown files in this directory. For stylistic choices like list indents or Oxford commas, this PR makes no decision and preserves existing usage. In general, this PR always favors consistency with existing choices over any standardization of style.
For now, I've touched only the
doc/devMarkdown files. I can clean up the Markdown files for other docs as well in the future.