-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Markdown integration #68
base: master
Are you sure you want to change the base?
Markdown integration #68
Conversation
- in-line documentation (argparser annotations) - javadoc documentation (still allows pure HTML)
Here you have the PR, @vdauwera! |
Codecov Report
@@ Coverage Diff @@
## master #68 +/- ##
===========================================
+ Coverage 74.08% 74.7% +0.61%
- Complexity 517 530 +13
===========================================
Files 21 21
Lines 1999 2012 +13
Branches 412 412
===========================================
+ Hits 1481 1503 +22
+ Misses 346 344 -2
+ Partials 172 165 -7
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't had a chance to look at this in detail yet (I'll get to it as soon as I can, but realistically it won't be until we get beta finished). One high-level request is that we find a way to incrementally unit-test new functionality like this at a granular level. We currently only have coarse-grained, file-based integration tests, and I'd like to find a way to avoid proliferating a new set of test files with each new feature, in addition to changing many/all of the existing ones. @magicDGS any thoughts on how we can address that ? |
I open an issue (#71) to discuss how to change the docgen tests. Let's keep this PR for the Markdown support, which may be also generate some discussion... |
Markdown integration in the CLI help and documentation generation using commonmark-java. Includes: