Consistency of dtype naming in docs #261
Assignees
Labels
documentation
Improvements or additions to documentation
Comments
Merged
Michael-T-McCann
pushed a commit
that referenced
this issue
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 <thilo.balke@gmail.com> * Implement PR review recommendations --------- Co-authored-by: Thilo Balke <thilo.balke@gmail.com>
Michael-T-McCann
added a commit
that referenced
this issue
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 <thilo.balke@gmail.com> * Implement PR review recommendations --------- Co-authored-by: Thilo Balke <thilo.balke@gmail.com> --------- Co-authored-by: Brendt Wohlberg <bwohlberg@users.noreply.github.com> Co-authored-by: Thilo Balke <thilo.balke@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
There are a number of different ways of writing dtypes in the docs, including forms
float32,np.float32, andnumpy.float32. We should choose one and ensure that usage is consistent.The text was updated successfully, but these errors were encountered: