libsubprocess: add extra documentation #6307
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
chu11
force-pushed
the
libsubprocess_documentation
branch
from
81ddabb to
d7a1998
Compare
Problem: There is a minor English error in the fbuf comments. Fix the English error.
Problem: There were some inconsistent tabbing in libsubprocess code. Fix up the tabbing.
Problem: Comments on the fbuf read and write watcher are a little thin. Add some additional comments to remind readers what the watchers do.
Problem: If output callbacks do not read from their respective buffers, it can lead to excessive callbacks and code spinning. Add comment about this in subprocess.h.
chu11
force-pushed
the
libsubprocess_documentation
branch
from
d7a1998 to
ee08669
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #6307 +/- ##
==========================================
- Coverage 83.32% 83.30% -0.02%
==========================================
Files 523 523
Lines 86133 86133
==========================================
- Hits 71770 71757 -13
- Misses 14363 14376 +13
|
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.
per comment in #6281 some extra comments could be useful. I did find myself struggling remembering how read vs write fbuf watchers behaved too.