Improve doc coverage (#44) #84
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
I added documentation to most public elements in `sophia/`, using the method described in the issue (pchampin#44) of adding `#![deny(missing_docs)]` to `sophia/src/lib.rs`. 2 doc comments are missing: - sophia/src/parser/rio_common.rs:72:1 sophia_api::make_scoped_triple_streaming_mode!(ScopedRioSourceTriple, RioSourceTriple); - sophia/src/parser/rio_common.rs:112:1 sophia_api::make_scoped_quad_streaming_mode!(ScopedRioSourceQuad, RioSourceQuad); I don't know how to add comments to the macro-created types.
I adapted the macros `make_scoped_triple_streaming_mode` and `make_scoped_quad_streaming_mode` to pass through attributes to the generated `struct`. A doc comment is reresented as `#[doc="..."]`. I learned this trick from https://stackoverflow.com/a/33999625/4696215
lulu-berlin
force-pushed
the
doc-coverage
branch
from
0a63c79
to
0de43fc
Compare
|
I have added the last missing doc comments in the This pull request is now ready to be reviewed. @pchampin |
- parser::xml - parser::xml_legacy
lulu-berlin
force-pushed
the
doc-coverage
branch
from
2a45120
to
1004ab0
Compare
pchampin
requested changes
Aug 28, 2020
Co-authored-by: Pierre-Antoine Champin <github-100614@champin.net>
Co-authored-by: Pierre-Antoine Champin <github-100614@champin.net>
Co-authored-by: Pierre-Antoine Champin <github-100614@champin.net>
Co-authored-by: Pierre-Antoine Champin <github-100614@champin.net>
Co-authored-by: Pierre-Antoine Champin <github-100614@champin.net>
Co-authored-by: Pierre-Antoine Champin <github-100614@champin.net>
Co-authored-by: Pierre-Antoine Champin <github-100614@champin.net>
Co-authored-by: Pierre-Antoine Champin <github-100614@champin.net>
Co-authored-by: Pierre-Antoine Champin <github-100614@champin.net>
Co-authored-by: Pierre-Antoine Champin <github-100614@champin.net>
|
Finally found a moment to merge this! Thanks again @yever |
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.
I added documentation to most public elements in
sophia/, usingthe method described in the issue (#44) of adding
#![deny(missing_docs)]to
sophia/src/lib.rs.2 doc comments are missing:sophia_api::make_scoped_triple_streaming_mode!(ScopedRioSourceTriple, RioSourceTriple);sophia_api::make_scoped_quad_streaming_mode!(ScopedRioSourceQuad, RioSourceQuad);I don't know how to add comments to the macro-created types.I found out that it's possible to add doc comments to macros (https://stackoverflow.com/a/33999625/4696215) and updated the relevant macros accordingly in a separate commit.