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.

Sign up for GitHub

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

Jump to bottom

Update documentation and avoid duplication #17

Closed
hdevalence opened this issue Dec 29, 2018 · 3 comments
Closed

Update documentation and avoid duplication #17

hdevalence opened this issue Dec 29, 2018 · 3 comments
Milestone
1.0.0

Comments

@hdevalence
Copy link
Contributor

Following #15, the documentation needs to be updated; right now it's duplicated across some markdown files and the source files.
@hdevalence hdevalence added this to the 0.4.0 milestone Dec 29, 2018
@isislovecruft
Copy link
Member

This ended up breaking the doctests because there's no way to comment out/make invisible test setup code when it's in the README (afaik). I guess we'll have to ignore the tests? Although, I kind of dislike that the doctests could get out of sync and we might not notice.

@hdevalence hdevalence reopened this Jan 18, 2019
@hdevalence
Copy link
Contributor Author

This wasn't actually done yet, I only moved the README around. The docs are still out of date with the new API.

@hdevalence hdevalence modified the milestones: 0.4.0, 1.0.0 Jan 20, 2019
@hdevalence
Copy link
Contributor Author

Fixed in #60

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
1.0.0
Development

No branches or pull requests
2 participants
@hdevalence @isislovecruft