Resolve #165 #415
Merged
Resolve #165 #415
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
bwohlberg
added
documentation
Codecov Report
@@ Coverage Diff @@
## main #415 +/- ##
==========================================
- Coverage 94.85% 94.84% -0.01%
==========================================
Files 83 83
Lines 5265 5281 +16
==========================================
+ Hits 4994 5009 +15
- Misses 271 272 +1
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Michael-T-McCann
approved these changes
May 15, 2023
docs/source/conf.py
Outdated
Comment on lines
385
to
390
| DType: ":obj:`~scico.typing.DType`", | ||
| Optional[DType]: ":obj:`~typing.Optional`\ [\ :obj:`~scico.typing.DType`\ ]", | ||
| Union[DType, Sequence[DType]]: ( | ||
| ":obj:`~typing.Union`\ [\ :obj:`~scico.typing.DType`\ , " | ||
| ":obj:`~typing.Sequence`\ [\ :obj:`~scico.typing.DType`\ ]]" | ||
| ), |
There was a problem hiding this comment.
As I understand it, you have to add each type that uses DType here. Correct? Perhaps add a comment along the lines of "add new types here".
There was a problem hiding this comment.
Yes, correct. Good point -- will do.
Michael-T-McCann
pushed a commit
that referenced
this pull request
May 19, 2023
* Resolve #261 (#416) * Improve markup for numpy.float32 etc. as well as some other docs improvements * Add note to style docs * Minor docs edit * Some markup changes * Resolve #165 (#415) * Add function for computing gaussian distribution * Typing fix and better default sigma * Address #165 * Fix docs typos and suppress apparently-spurious type error * Target clean also cleans _autosummary directory * Use new TypeAlias declaration * Suppress type error * Avoid pollution of docs with excessively long type alias definition * Add comment as per PR review suggestion * Resolve #83 (#417) * Attempt to remove rtd edit on github button * Bump jaxlib/jax max versions * Remove function no longer in jax.numpy * Resolve #377 (#418) * Fix markup * Docstring edits * Change sphinx theme * Docstring fixes * Theme customization * Clean up * Fix inheritance diagram insertion * Resolve document not in any toctree warning for index.ipynb * Clean up * Update submodule * Adjust css * Avoid problems with dark mode * Add version number in sidebar * Change inheritance diagram color scheme * Clean up * Correct path to docs_requirements --------- Co-authored-by: Thilo Balke <[email protected]> * Implement PR review recommendations --------- Co-authored-by: Thilo Balke <[email protected]>
Michael-T-McCann
added a commit
that referenced
this pull request
May 19, 2023
* Rename test file * Add function and tests * Replace try-and-see code with new function * Implement #419 review recommendations (#421) * Resolve #261 (#416) * Improve markup for numpy.float32 etc. as well as some other docs improvements * Add note to style docs * Minor docs edit * Some markup changes * Resolve #165 (#415) * Add function for computing gaussian distribution * Typing fix and better default sigma * Address #165 * Fix docs typos and suppress apparently-spurious type error * Target clean also cleans _autosummary directory * Use new TypeAlias declaration * Suppress type error * Avoid pollution of docs with excessively long type alias definition * Add comment as per PR review suggestion * Resolve #83 (#417) * Attempt to remove rtd edit on github button * Bump jaxlib/jax max versions * Remove function no longer in jax.numpy * Resolve #377 (#418) * Fix markup * Docstring edits * Change sphinx theme * Docstring fixes * Theme customization * Clean up * Fix inheritance diagram insertion * Resolve document not in any toctree warning for index.ipynb * Clean up * Update submodule * Adjust css * Avoid problems with dark mode * Add version number in sidebar * Change inheritance diagram color scheme * Clean up * Correct path to docs_requirements --------- Co-authored-by: Thilo Balke <[email protected]> * Implement PR review recommendations --------- Co-authored-by: Thilo Balke <[email protected]> --------- Co-authored-by: Brendt Wohlberg <[email protected]> Co-authored-by: Thilo Balke <[email protected]>
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.
Resolve #165 and modify Sphinx configuration to avoid expansion of the much longer definition of
DTypefrom making parts of the docs unreadable. Also introduce newTypeAliasdeclaration inscico.typingand add a support function for use in future example scripts.