Added '--markup' option. #180
Closed
Conversation
This file contains hidden or 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
|
Thanks for the PR! refs #153 |
|
thanks. |
kernc
reviewed
Nov 7, 2018
| @@ -99,7 +100,22 @@ | |||
| default=8080, | |||
| help="The port on which to run the HTTP server.", | |||
| ) | |||
| aa( | |||
| "--style", | |||
There was a problem hiding this comment.
I would prefer --docstring-style. Less ambiguous.
mhils
reviewed
Nov 7, 2018
| <table id="module-list"> | ||
| % for root in roots: | ||
| <tr> | ||
| <td><a href="${link_prefix}${root.name}">${root.name}</a></td> | ||
| <td> | ||
| % if len(root.docstring.strip()) > 0: | ||
| <div class="desc">${root.docstring | hh.mark}</div> | ||
| <div class="desc}">${root.docstring | hh.mark(markup)}</div> |
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.
Hello.
We are using pdoc for our internal packages. That's very convenient!
However, Some my coworkers are unwilling for pdoc because pdoc assumes all docstrings are written in Markdown and formats their plain-text docstrings wrongly.
Therefore I added
--styleoption:--style=markdown: to interpret as Markdown (current and default behavior).--style=pre: just to wrap docstring with <pre>.I bet that
--styleis going to boost the users of pdoc.I think Google's style and Numpy's style are also expected by not a few people. I will add this two styles if this pull-request is accepted. (However, Currently, I do not have enough time.)
Thanks.