WIP: Documentation: jsdoc2markdown within GitHub #21
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
pimotte
force-pushed
the
documentation/jsdoc-2-markdown-within-github
branch
from
285c42f to
b7d344e
Compare
Codecov Report
@@ Coverage Diff @@
## master #21 +/- ##
=========================================
- Coverage 98.78% 98.18% -0.6%
=========================================
Files 3 3
Lines 164 165 +1
=========================================
Hits 162 162
- Misses 2 3 +1
Continue to review full report at Codecov.
|
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.
Example how this documentation option would look.
I'm not terribly thrilled about it, but it's something.
I've also included a step in the build that checks whether the documentation is up to date. We could progress that to auto updating it from travis, but that requires giving it push permissions somehow, which I'm not a big fan of.