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

Documentation update #175

Merged
merged 45 commits into from
Mar 2, 2019
Merged

Documentation update #175

merged 45 commits into from
Mar 2, 2019

Conversation

jklenzing
Copy link
Member

Closes #69, #94, and #153.

Summary of changes

@jklenzing jklenzing moved this from In progress to Needs review in Documentation Update Feb 24, 2019
@coveralls
Copy link

coveralls commented Feb 24, 2019

Coverage Status

Coverage remained the same at 76.648% when pulling 267b79f on documentation into ed3c512 on develop.

Copy link
Member

@aburrell aburrell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other comments relate to content of new_instrument.rst:

  • Supported Data Templates should include Madrigal
  • A section with a list of the optional, but standard inst routines should be added.
  • Where and how to add data acknowledgements should be added.

docs/examples.rst Outdated Show resolved Hide resolved
@jklenzing
Copy link
Member Author

Other comments relate to content of new_instrument.rst:

* Supported Data Templates should include Madrigal

Added. Madrigal currently does not use functools.partial. Is this something we should update?

Writing up documentation for current methods.

@jklenzing
Copy link
Member Author

Updates completed. We should have a larger conversation about how the acknowledgements are implemented.

@rstoneback rstoneback added this to the 2.0.0 Release milestone Mar 1, 2019
Copy link
Collaborator

@rstoneback rstoneback left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noted an area that needs tweaking, but otherwise looks good.

I was a bit surprised myself that the madrigal code didn't use functools. I don't remember why that is. Updating it would improve style consistency but wouldn't change overall functionality.

docs/new_instrument.rst Show resolved Hide resolved
@jklenzing
Copy link
Member Author

Updates to madrigal are out of scope here. Adding a note to #106.

@jklenzing jklenzing merged commit 8c14861 into develop Mar 2, 2019
Documentation Update automation moved this from Needs review to Done Mar 2, 2019
@jklenzing jklenzing deleted the documentation branch March 2, 2019 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants