LeopoldArkham / Molten

[WIP] Molten - Style-preserving TOML parser.
Apache License 2.0
40 stars 8 forks source link

Add documentation to allow #![deny(missing_docs)]. #34

Closed markcol closed 6 years ago

markcol commented 6 years ago

Add documentation to all functions, structs, and types to satisfy the linter when #[deny(missing_docs)] is used. Module-level documentation is still not included for the internal modules since it's really redundant at the moment, so #[deny(missing_docs)] is not currently enabled by default. The documentation for many functions are quite terse and could use additional information to make them accessible for end-users of the library.

LeopoldArkham commented 6 years ago

Thank you, @markcol, it'll look much better this way. I notice you used declarative and imperative forms in the comments; Should we settle on one and use it throughout? I like declarative myself but don't care that much either way.

LeopoldArkham commented 6 years ago

Never mind, all done!