Simplify README#123
Open
mbauman wants to merge 1 commit into
Open
Conversation
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.
mbauman
force-pushed
the
mb/unreadme
branch
from
6a9a43b to
d6797e7
Compare
Collaborator
|
See #127 |
Member
|
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. |
Member
|
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) |
Member
|
On balance I favor having "one true source," so I say we should go with something like this. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.