Skip to content
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 tooling to report method inheritance cascades for objects #93

Merged
merged 5 commits into from
Sep 13, 2019

Conversation

bskinn
Copy link
Owner

@bskinn bskinn commented Sep 12, 2019

Uses doctests to indicate whether the inheritance information in the docs needs updating. Output of current POC. Now merged. See latest.

Adds doctests to CI, both Travis and Azure.

Still have to manually update based on doctest results,
but at least it's easy to keep it fresh/accurate -- just
copy/paste from the failed doctest output.
Constrain pytest doctests to just README, which Sphinx can't
easily reach.

Only installing docs requirements for 3.7 b/c Sphinx>=2
doesn't support 3.4.
No reason to repeat the nearly identical job content
Copy link
Contributor

@jayvdb jayvdb left a comment

Choose a reason for hiding this comment

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

this would make a great sphinx plugin

Have to use the Python console style for now, for cross-platform
compat (currently the shell execution is hardcoded to bash).

Also, it looks like there's no way to add 'setup' code to run,
so for now the preamble with runpy &c. seems to be unavoidable.
@bskinn
Copy link
Owner Author

bskinn commented Sep 13, 2019

Oy, just what I need, another side project! 😛

@codecov-io
Copy link

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##             master    #93   +/-   ##
=======================================
  Coverage          ?   100%           
=======================================
  Files             ?      3           
  Lines             ?    101           
  Branches          ?      0           
=======================================
  Hits              ?    101           
  Misses            ?      0           
  Partials          ?      0

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0c29185...98eed67. Read the comment docs.

@bskinn
Copy link
Owner Author

bskinn commented Sep 13, 2019

Ok, that's nice and concise, now. Syntax should be pretty straightforward; just add any objects of interest to doc/source/attr_inheritance.rst

Any idea how to sniff out where the propertys are defined? I nosed around a bit but couldn't nail down anything definite.

Any desired changes to the output?

@bskinn bskinn merged commit a8b533f into master Sep 13, 2019
@bskinn bskinn deleted the method-list branch September 13, 2019 03:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants