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

WiP: in-Python documentation #110

Closed
wants to merge 6 commits into from
Closed

WiP: in-Python documentation #110

wants to merge 6 commits into from

Conversation

nbraud
Copy link
Collaborator

@nbraud nbraud commented Jan 19, 2019

Closes #109

  • Move documentation from README to docstrings.
  • Improve the treatment of complex types such as VectorLike or Realish.
  • Generate a documentation page from the docstrings (in CI), link to it from README.

Copy link
Collaborator

@pathunstrom pathunstrom left a 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.

@nbraud
Copy link
Collaborator Author

nbraud commented Jan 19, 2019

@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?

@AstraLuma
Copy link
Member

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).

@nbraud
Copy link
Collaborator Author

nbraud commented Jan 22, 2019

@pathunstrom OK, is this the next #85? Should I just disregard the negative review and go with Jamie's recommendation?

@pathunstrom pathunstrom dismissed their stale review January 22, 2019 20:44

Letting Jamie's call stand.

@nbraud nbraud mentioned this pull request Feb 4, 2019
@nbraud
Copy link
Collaborator Author

nbraud commented Mar 16, 2019

Rebased to solve the merge conflict.

@nbraud
Copy link
Collaborator Author

nbraud commented Mar 23, 2019

Obsoleted by #128

@nbraud nbraud closed this Mar 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants