-
-
Notifications
You must be signed in to change notification settings - Fork 146
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
Add support for variable doc-comments starting with '#:' #292
Conversation
803f7fd
to
e52311f
Compare
e52311f
to
ce4893c
Compare
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.
Looks neat! But definitely will need a unit test. 😬
@kernc, added unit tests, fixed running on Windows. Let me know if it needs other changes. Otherwise feel free to merge. |
@kernc let me know if further changes are needed. Thanks! |
Co-authored-by: kernc <kerncece@gmail.com>
@kernc I've made the requested changes. Let me know if it seems ok now. Thanks! |
Now with this feature in place, amendment of documentation is in order: Lines 106 to 137 in 28b366a
|
@kernc added documentation, fixed test. Please check again. Thanks. |
Applied with slight modification. This is a great feature. Many thanks @csm10495! ✨ |
…3#292) * Add support for variable docstrings starting with '#:' * Get tests passing on Windows * Updates from the PRD * Add some unit tests, lint * Update pdoc/__init__.py * PR fixes * PR updates, add documentation * Revert unrelated change * Touch ups * Reword docs
I'd like to write a unit-test for this functionality, though I'm having some trouble running the existing suite: #291
This basically matches up with sphinx behavior and a similar implementation.
Fixes #289
Resolves #291