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

Restore missing BlockArray docs #285

Merged
merged 10 commits into from
May 6, 2022
Merged

Restore missing BlockArray docs #285

merged 10 commits into from
May 6, 2022

Conversation

bwohlberg
Copy link
Collaborator

A side of effect of #259 was removal of the detailed BlockArray docs (see readthedocs). Fixing this required

  1. Moving scico.numpy.blockarray to scico.numpy._blockarray since the blockarray = BlockArray.blockarray line in scico/numpy/__init__.py overwrote the use of blockarray as a submodule name.
  2. Moving the detailed docs into a Sphinx .rst file since there were additional difficulties in including the docs from scico.numpy._blockarray.

Some attention is still required, as indicated in comments to be added after creation of the PR.

@bwohlberg bwohlberg added the documentation Improvements or additions to documentation label May 2, 2022
docs/source/blockarray.rst Outdated Show resolved Hide resolved
scico/numpy/_blockarray.py Outdated Show resolved Hide resolved
docs/source/blockarray.rst Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented May 4, 2022

Codecov Report

Merging #285 (eef8cea) into main (85b9942) will increase coverage by 0.00%.
The diff coverage is 97.56%.

@@           Coverage Diff           @@
##             main     #285   +/-   ##
=======================================
  Coverage   94.15%   94.15%           
=======================================
  Files          49       49           
  Lines        3267     3269    +2     
=======================================
+ Hits         3076     3078    +2     
  Misses        191      191           
Flag Coverage Δ
unittests 94.15% <97.56%> (+<0.01%) ⬆️

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

Impacted Files Coverage Δ
scico/scipy/__init__.py 100.00% <ø> (ø)
scico/numpy/_blockarray.py 97.33% <97.33%> (ø)
scico/numpy/__init__.py 100.00% <100.00%> (ø)
scico/numpy/_wrappers.py 97.10% <100.00%> (ø)
scico/numpy/util.py 97.46% <100.00%> (ø)
scico/scipy/special.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 85b9942...eef8cea. Read the comment docs.

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.

Thanks for catching this and fixing it!

@bwohlberg bwohlberg merged commit 4dc86b8 into main May 6, 2022
@bwohlberg bwohlberg deleted the brendt/docs-fix branch May 6, 2022 16:37
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.

2 participants