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

Interleave doctest examples w/ API ref docs. #1150

Closed
wants to merge 1 commit into from
Closed

Interleave doctest examples w/ API ref docs. #1150

wants to merge 1 commit into from

Conversation

tseaver
Copy link
Contributor

@tseaver tseaver commented Sep 23, 2015

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Sep 23, 2015
@dhermes
Copy link
Contributor

dhermes commented Sep 24, 2015

How to review this? Why ditch :members: and :undoc-members:?

@tseaver
Copy link
Contributor Author

tseaver commented Sep 28, 2015

The PR trades off removing some DRY (the :members: and particularly :undoc-members:, which should arguable be excluded in any case) in exchange for getting control over the generation of the API docs (ordering, plus the ability to interleave the doctest examples in the Sphinx docs, with the promise of future testability).

It also makes the API docs more suitable for addition of exposition by non-programmer techwriters.

@dhermes
Copy link
Contributor

dhermes commented Sep 28, 2015

But how do we make sure we haven't left anything out (the time-honored "check yourself (programatically) before you wreck yourself")?

@tseaver tseaver closed this Mar 31, 2016
@tseaver tseaver deleted the 1141-pubsub_examples_in_apiref branch March 31, 2016 18:25
@dhermes
Copy link
Contributor

dhermes commented Mar 31, 2016

@tseaver Why do we consider this closed?

UPDATE: Oh duh it's a PR. So much fail!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants