question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Harmonize docstring for test_stat between AsymptoticCalculator and ToyCalculator

See original GitHub issue

Description

In v0.6.0 docs, the AsymptoticCalculator API has a nicely formatted docstring for the test_stat arg

https://github.com/scikit-hep/pyhf/blob/8de7566a2b6dc4a5278e0b0da9c0a45a2e5a752d/src/pyhf/infer/calculators.py#L199-L208

but the ToyCalculator API didn’t have these changes applied to them (seems @matthewfeickert forgot to propagate these in PR #993)

https://github.com/scikit-hep/pyhf/blob/8de7566a2b6dc4a5278e0b0da9c0a45a2e5a752d/src/pyhf/infer/calculators.py#L625-L632

The ToyCalculator docstring should be updated to match.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:6 (6 by maintainers)

github_iconTop GitHub Comments

1reaction
kratsgcommented, Feb 22, 2021

Similarly, need to update the warning for qmu to be using qmu_tilde with the more appropriate suggestion.

0reactions
Saransh-cppcommented, Sep 8, 2021

Oh oh, my bad, I thought this required only formatting of the documentation. Thanks for letting me know!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Releases · scikit-hep/pyhf - GitHub
This is a minor release from v0.6.3 → v0.7.0 . ... docs: Harmonize docstring for test_stat in ToyCalculator by @kratsg in #1970; feat:...
Read more >
pyhf Documentation
The relationship between them is often formalised in a statistical model /(x|) ... The calculator API also serves to harmonize the extraction of...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found