Documentation improvements #34
Closed
Conversation
This file contains 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
| @@ -1,6 +1,6 @@ | |||
| The MIT License (MIT) | |||
|
|
|||
| Copyright (c) 2014 unbit | |||
| Copyright (c) 2015 unbit | |||
|
I will clean up the history and look into markdown vs restructured text for pypi. |
|
@xrmx what are your thoughts on this https://coderwall.com/p/qawuyq/use-markdown-readme-s-in-python-modules? |
|
@iiSeymour i think it is overkill, rst is very similar to md so not much changes are needed. I can do the conversion myself so just update the pull request with the two README related commits and i'll take care of it. |
iiSeymour
force-pushed
the
documentation
branch
from
220b0a9 to
f1ff5fd
Compare
|
@xrmx you are right. Seeing as github supports both markdown and rst but pypi only supports rst the best thing to do is use rst. I accidentally rebased a few too many commits to I'll submit a new clean PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
A few documentation improvements:
incremented the copyright year.[moved to separate PR]READMEfile.README.md.README.mdwith markdown.The rendered version of the
README.mdcan be seen here.