Skip to content

Conversation

@hardbyte
Copy link
Owner

@hardbyte hardbyte commented Sep 24, 2018

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 the can.viewer as it returns an error code - see #427

@hardbyte hardbyte requested a review from felixdivo September 24, 2018 06:28
@codecov
Copy link

codecov bot commented Sep 24, 2018

Codecov Report

❗ No coverage uploaded for pull request base (develop@832eee6). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             develop     #428   +/-   ##
==========================================
  Coverage           ?   62.29%           
==========================================
  Files              ?       55           
  Lines              ?     4612           
  Branches           ?        0           
==========================================
  Hits               ?     2873           
  Misses             ?     1739           
  Partials           ?        0

@felixdivo
Copy link
Collaborator

Yeah, all of them should respond with error 22. The error is this one:
#define EINVAL 22 /* Invalid argument */

The help is printed to the console anyways.

@hardbyte hardbyte force-pushed the feature-extract-cli-help branch from 99d4de8 to e7ff9a8 Compare September 25, 2018 10:26
@hardbyte hardbyte force-pushed the feature-extract-cli-help branch from e7ff9a8 to ce5ac4b Compare September 27, 2018 10:36
.. autoclass:: can.BusABC
:private-members:
:special-members:
:noindex:
Copy link
Collaborator

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.

Copy link
Collaborator

@felixdivo felixdivo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good & clean!

@felixdivo felixdivo merged commit db1fc25 into develop Sep 27, 2018
@hardbyte hardbyte deleted the feature-extract-cli-help branch September 29, 2018 00:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants