-
Notifications
You must be signed in to change notification settings - Fork 659
Extract cli help automatically #428
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
Conversation
Codecov Report
@@ Coverage Diff @@
## develop #428 +/- ##
==========================================
Coverage ? 62.29%
==========================================
Files ? 55
Lines ? 4612
Branches ? 0
==========================================
Hits ? 2873
Misses ? 1739
Partials ? 0 |
|
Yeah, all of them should respond with error 22. The error is this one: The help is printed to the console anyways. |
99d4de8 to
e7ff9a8
Compare
e7ff9a8 to
ce5ac4b
Compare
| .. autoclass:: can.BusABC | ||
| :private-members: | ||
| :special-members: | ||
| :noindex: |
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.
This fixes some of the Sphinx errors, but adds
WARNING: py:meth reference target not found: can.BusABC._apply_filters
for all "private" methods.
felixdivo
left a comment
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 good & clean!
I noticed we had a lot of direct command line output in our docs - there is a sphinx plugin that will extract that for us.
I didn't use it on thecan.vieweras it returns an error code - see #427