Cleanup Sphinx documentation #3029
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Apply numpydoc style (only one level of indentation for parameter descriptions, no single quote around parameter names, allowed values listed within curly braces), remove duplicated docstrings, use LaTeX math to display equations of constraints, fix broken Sphinx syntax (directives start with two dots, add missing links, etc.).
Codecov Report
@@ Coverage Diff @@
## python #3029 +/- ##
======================================
Coverage 82% 82%
======================================
Files 527 527
Lines 26791 26791
======================================
Hits 22080 22080
Misses 4711 4711Continue to review full report at Codecov.
|
pkreissl
reviewed
Jul 30, 2019
jngrad
commented
Jul 30, 2019
pkreissl
approved these changes
Jul 31, 2019
fweik
approved these changes
Jul 31, 2019
|
bors r+ |
bors bot
added a commit
that referenced
this pull request
Jul 31, 2019
3029: Cleanup Sphinx documentation r=fweik a=jngrad Clean up Sphinx documentation of files affected by #3026: - apply numpydoc style (indentation level of param descriptions, show allowed param values) - remove duplicated docstrings, add missing words - use LaTeX math to display equations of constraints - fix broken Sphinx syntax (typos, unparsed `.. notes::` directives, missing links, etc.). Co-authored-by: Jean-Noël Grad <jgrad@icp.uni-stuttgart.de>
|
- rotation : (int,int,int)
+ rotation : list of :obj:`int`
offline discussion: <https://github.com/pkreissl> @pkreissl will take care of this in a new PR after this one is merged.
In case that’s not there yet, a link might be added to the section on rotational degrees of freedom in the user’s guide, both, here and for the other rotation-related properties.
|
Build succeeded |
bors bot
added a commit
that referenced
this pull request
Aug 6, 2019
3043: Sphinx Doc: Replace `array_like` and 'list of' with `(N,) array_like of` where appropriate. r=jngrad a=pkreissl Follow up on PR #3029. As discussed offline this PR changes the code documentation such that the non-specific `array_like` inputs are replaced by n-tuples where appropriate. Description of changes: - Array-like input parameters of a fixed expected length are documented as `<n>-tuple of :obj:<type>`. This style is used by numpy-doc for fixed-length inputs, see e.g. the `axis` parameter in [numpy.linalg.norm](https://docs.scipy.org/doc/numpy/reference/generated/numpy.linalg.norm.html). - Array-like input parameters with variable length are kept as `array_like`. - Return arrays are usually of type `ndarray`. This is updated where appropriate. Co-authored-by: Patrick Kreissl <patrick.kreissl@pa-le.de> Co-authored-by: Jean-Noël Grad <jgrad@icp.uni-stuttgart.de>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Clean up Sphinx documentation of files affected by #3026:
.. notes::directives, missing links, etc.).