Documentation: updates and fixes/review #288
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
About
measurement_set_overview
, I only made small or technical fixes. The few points about content that came to mind:For the API fixes, I used the
:members:
directive. It seems we could also auto-generate everything as-is in the code using the extension 'sphinx.ext.autosummary'. Maybe we want to use that in the near future once the API is stable.Note that I changed the top heading of
measurement_set_api.rst
to "Processing Set and Measurement Set API" as this made better sense to me considering what is included there, but please double-check.Note well: