Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: multiple minor docstring fixes #274

Merged
merged 4 commits into from
Aug 31, 2021

Conversation

alexander-held
Copy link
Member

@alexander-held alexander-held commented Aug 31, 2021

This adopts np.ndarray in docstrings, where in some cases previously numpy.ndarray was used. The type of cabinetry.fit.results_containers.LimitResults.observed_limit was wrong in the docstring, this is also fixed. A few issues flagged by pydocstyle (via pydocstyle --convention google src/cabinetry/) are also fixed, and pre-commit is updated.

* harmonized use of np.ndarray in docstrings
* fixed type of LimitResults.observed_limit in docstring
* multiple minor docstring formatting fixes
* pre-commit updated

@codecov
Copy link

codecov bot commented Aug 31, 2021

Codecov Report

Merging #274 (3f823b9) into master (894ed2a) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            master      #274   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           19        19           
  Lines         1798      1798           
  Branches       279       279           
=========================================
  Hits          1798      1798           
Impacted Files Coverage Δ
src/cabinetry/contrib/histogram_creation.py 100.00% <ø> (ø)
src/cabinetry/fit/results_containers.py 100.00% <ø> (ø)
src/cabinetry/histo.py 100.00% <ø> (ø)
src/cabinetry/model_utils.py 100.00% <ø> (ø)
src/cabinetry/template_builder.py 100.00% <ø> (ø)
src/cabinetry/visualize/plot_model.py 100.00% <ø> (ø)
src/cabinetry/workspace.py 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 894ed2a...3f823b9. Read the comment docs.

@alexander-held alexander-held changed the title docs: small type fixes in docstrings docs: multiple minor docstring fixes Aug 31, 2021
@alexander-held alexander-held merged commit e45e89f into master Aug 31, 2021
@alexander-held alexander-held deleted the docs/docstring-type-fixes branch August 31, 2021 19:39
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant