doc(common): documentation improvements #11376
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
The `Status` and `StatusOr` classes are very important and are missing documentation in DocFX. This fleshes out the output a little bit. The landing page (which I am constantly looking at) had some formatting problems (two `warning` sections back-to-back) and could use some improvements.
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## main #11376 +/- ##
==========================================
- Coverage 93.73% 93.73% -0.01%
==========================================
Files 1797 1797
Lines 160588 160588
==========================================
- Hits 150529 150523 -6
- Misses 10059 10065 +6
... and 7 files with indirect coverage changes 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 in Codecov by Sentry. |
devbww
reviewed
Apr 25, 2023
Comment on lines
+136
to
+137
| /// attempted past the valid range, such as seeking or reading past an | ||
| /// end-of-file. |
There was a problem hiding this comment.
Nit: Those examples may not be best. The matching syscalls, for example, don't do that.
There was a problem hiding this comment.
Ack. I am trying to follow the documentation from Abseil and gRPC. Getting creative (even if it improves correctness) seems risky.
devbww
approved these changes
Apr 25, 2023
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.
The
StatusandStatusOrclasses are very important and are missing documentation in DocFX. This fleshes out the output a little bit.The landing page (which I am constantly looking at) had some formatting problems (two
warningsections back-to-back) and could use some improvements.This change is