Increase Documentation Coverage #543
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
Michael-F-Bryan
force-pushed
the
moar-docs
branch
5 times, most recently
from
c861966 to
3c502db
Compare
3 tasks
Michael-F-Bryan
force-pushed
the
moar-docs
branch
from
8b6c651 to
96df358
Compare
|
The preprocessor section can probably be fleshed out a bit, but other than that the docs are pretty much ready to merge. The main thing was making sure we have as much documentation coverage as possible in the API docs. The user guide can easily be updated after the 0.1 release. |
Ruin0x11
pushed a commit
to Ruin0x11/mdBook
that referenced
this pull request
Aug 30, 2020
* Added documentation to the `config` module * Added an example to the `config` module * Updated the docs in lib.rs regarding implementing backends * Started writing an alternate backends walkthrough * Mentioned the output.foo.command key * Added example output * Added a config section to the backends tutorial * Finished off the backends tutorial * Made sure travis checks mdbook-wordcount * Fixed the broken link at in the user guide * Changed how travis builds the project * Added a conclusion * Went through and documented a lot of stuff * Added a preprocessors chapter and updated For Developers
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've incrementally been adding
#![deny(missing_docs)]to the various modules inmdbookto make sure they get documented. This adds a couple more modules to the list, hopefully adding in-depth examples and stuff.This also adds a pretty in-depth tutorial on how to create a new backend (rendered).