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

docs(backport): Correct fixed_params type to tuple or list #2428

Merged
merged 1 commit into from
Jan 5, 2024

Conversation

matthewfeickert
Copy link
Member

Description

  • Backport PR docs: Correct fixed_params type to tuple or list #2420
  • fixed_params is an iterable that is of type tuple or list. Though operations on it may support tensor types, not all operations will necessarily be supported and so the docs should not list it as being a tensor.

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* Backport PR https://github.com/scikit-hep/pyhf/pull/2420
* `fixed_params` is an iterable that is of type tuple or list. Though
  operations on it may support tensor types, not all operations will
  necessarily be supported and so the docs should not list it as being
  a tensor.

* Backport PR https://github.com/scikit-hep/pyhf/pull/ 2420
* `fixed_params` is an iterable that is of type tuple or list. Though
  operations on it may support tensor types, not all operations will
  necessarily be supported and so the docs should not list it as being
  a tensor.
@matthewfeickert matthewfeickert added docs Documentation related backport Backport PRs from main to release branch labels Jan 5, 2024
@matthewfeickert matthewfeickert self-assigned this Jan 5, 2024
Copy link

codecov bot commented Jan 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (release/v0.7.x@6bf1f4a). Click here to learn what that means.

Additional details and impacted files
@@                Coverage Diff                @@
##             release/v0.7.x    #2428   +/-   ##
=================================================
  Coverage                  ?   98.21%           
=================================================
  Files                     ?       69           
  Lines                     ?     4543           
  Branches                  ?      803           
=================================================
  Hits                      ?     4462           
  Misses                    ?       47           
  Partials                  ?       34           
Flag Coverage Δ
contrib 27.53% <0.00%> (?)
doctest 60.99% <0.00%> (?)
unittests-3.10 96.25% <0.00%> (?)
unittests-3.11 96.25% <0.00%> (?)
unittests-3.7 96.23% <0.00%> (?)
unittests-3.8 96.27% <0.00%> (?)
unittests-3.9 96.30% <0.00%> (?)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@matthewfeickert matthewfeickert merged commit 1edf68e into release/v0.7.x Jan 5, 2024
18 checks passed
@matthewfeickert matthewfeickert deleted the backport/docs-tensor-to-list branch January 5, 2024 16:29
matthewfeickert added a commit that referenced this pull request Jan 5, 2024
* The original PR was PR #2420 and the backport PR was PR #2428.
* Amends PR #2430.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Backport PRs from main to release branch docs Documentation related
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant