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

Resolve #377 #418

Merged
merged 17 commits into from
May 16, 2023
Merged

Resolve #377 #418

merged 17 commits into from
May 16, 2023

Conversation

bwohlberg
Copy link
Collaborator

Resolve #377.

@bwohlberg bwohlberg added the documentation Improvements or additions to documentation label May 13, 2023
@codecov
Copy link

codecov bot commented May 13, 2023

Codecov Report

Merging #418 (35ee6ed) into main (8b27075) will decrease coverage by 0.01%.
The diff coverage is 96.15%.

@@            Coverage Diff             @@
##             main     #418      +/-   ##
==========================================
- Coverage   94.85%   94.84%   -0.01%     
==========================================
  Files          83       83              
  Lines        5265     5281      +16     
==========================================
+ Hits         4994     5009      +15     
- Misses        271      272       +1     
Flag Coverage Δ
unittests 94.84% <96.15%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
scico/flax/examples/data_generation.py 74.10% <ø> (ø)
scico/numpy/_wrapped_function_lists.py 100.00% <ø> (ø)
scico/numpy/_wrappers.py 98.68% <ø> (ø)
scico/numpy/util.py 97.36% <ø> (ø)
scico/typing.py 94.11% <90.00%> (-5.89%) ⬇️
scico/examples.py 100.00% <100.00%> (ø)
scico/linop/_diff.py 98.30% <100.00%> (ø)
scico/numpy/_blockarray.py 97.43% <100.00%> (ø)

Copy link
Contributor

@Michael-T-McCann Michael-T-McCann left a comment

Choose a reason for hiding this comment

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

(I looked at the built version on readthedocs, not the code changes.) Looks great in my browser!

@bwohlberg bwohlberg merged commit 72f1597 into main May 16, 2023
16 of 17 checks passed
@bwohlberg bwohlberg deleted the brendt/issue377 branch May 16, 2023 00:05
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 <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 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 <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
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

New sphinx theme needs to be chosen
3 participants