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

doc improvements #4

Open
philpennock opened this issue Nov 30, 2016 · 0 comments
Open

doc improvements #4

philpennock opened this issue Nov 30, 2016 · 0 comments
Assignees
@philpennock
Labels
enhancement

Comments

@philpennock
Copy link
Member

Every package should have a package comment providing documentation, with attention paid to the short text in the top-level package's sub-package links.

The top-level README should include a worked example.

Should probably have executable examples for testing.

What else?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@philpennock philpennock

Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@philpennock