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

writing docs #17

Open
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
1 participant
@sixpearls
Copy link
Owner

commented May 9, 2019

@ixjlyons I'm starting to write docs! I put a bunch of it in the readme, which does not render well on github. Do you have suggestions for organizing? And obviously any editing, etc would be welcome.

I also added the numpydoc extension for the docstrings, which might be more trouble than it's worth. Their documentation has a styleguide, which suggested keeping the doc strings themselves easier to read un-rendered. I am not sure if the extension is worth the effort, but the style guide makes sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.