pchampin / sophia_rs

Sophia: a Rust toolkit for RDF and Linked Data
Other
210 stars 23 forks source link

Improve doc coverage (#44) #84

Closed lulu-berlin closed 3 years ago

lulu-berlin commented 3 years ago

I added documentation to most public elements in sophia/, using the method described in the issue (#44) of adding #![deny(missing_docs)] to sophia/src/lib.rs.

~2 doc comments are missing:~

~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.

lulu-berlin commented 3 years ago

I have added the last missing doc comments in the sophia crate and now the travis build is green :)

This pull request is now ready to be reviewed. @pchampin

pchampin commented 3 years ago

Finally found a moment to merge this! Thanks again @yever