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

Simplify README #123

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Simplify README #123

wants to merge 1 commit into from

Conversation

mbauman
Copy link
Member

@mbauman mbauman commented Sep 20, 2017

Now that we have doctests, it is even more important that we reduce the duplication here to ensure that the real documentation is the one canonical source.

Now that we have doctests, it is even more important that we reduce the duplication here to ensure that the real documentation is the one canonical source.
@iamed2
Copy link
Collaborator

iamed2 commented Oct 16, 2017

See #127

@c42f
Copy link
Member

c42f commented Dec 11, 2018

Looks great to me, I just wasted a little time being confused by the two locations of documentation for this package.

If there are "real" docs with real doctests, it's best just to point the README to those in a very prominent way, I think.

@c42f
Copy link
Member

c42f commented Dec 11, 2018

Hmm. Looking at the conflicts, not all changes to the README have been done in the docs.

Even more reason to do this (but now can't merge a straightforward version of this without loosing content)

@timholy
Copy link
Member

timholy commented Dec 11, 2018

On balance I favor having "one true source," so I say we should go with something like this.

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.

5 participants