-
-
Notifications
You must be signed in to change notification settings - Fork 18
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
WiP: in-Python documentation #110
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't remove the documentation from the readme.
@pathunstrom Would have been nice to have feedback in #109 when that was suggested (2 days ago) rather than once I started... What is the alternative you suggest? Maintaining all documentation in two places? |
I'm ok with removing the documentation from the readme if it's available elsewhere online. The readme only needs a summary in that case (eg, full API docs produced with Sphinx). |
@pathunstrom OK, is this the next #85? Should I just disregard the negative review and go with Jamie's recommendation? |
Rebased to solve the merge conflict. |
Obsoleted by #128 |
Closes #109
README
to docstrings.VectorLike
orRealish
.README
.