Skip to content

Commit

Permalink
docs: Update README to address JOSS reviewer changes (#1266)
Browse files Browse the repository at this point in the history
* Split out heredoc formatting example in README into input and output
* Add explicit fig.show() to plotting examples in README
  • Loading branch information
matthewfeickert authored Jan 19, 2021
1 parent bc140a7 commit 0e71f2f
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,7 @@ Alternatively the statistical model and observational data can be read from its
Observed: 0.3599840922126626, Expected: 0.3599840922126626
Finally, you can also use the command line interface that ``pyhf`` provides which
should produce the following JSON output:
Finally, you can also use the command line interface that ``pyhf`` provides

.. code:: bash
Expand Down Expand Up @@ -92,6 +91,11 @@ should produce the following JSON output:
"version": "1.0.0"
}
EOF
which should produce the following JSON output:
.. code:: json
{
"CLs_exp": [
0.0026062609501074576,
Expand Down Expand Up @@ -168,6 +172,7 @@ A one bin example
ax.set_xlabel(r"$\mu$ (POI)")
ax.set_ylabel(r"$\mathrm{CL}_{s}$")
pyhf.contrib.viz.brazil.plot_results(ax, poi_vals, results)
fig.show()
**pyhf**
Expand Down Expand Up @@ -212,6 +217,7 @@ A two bin example
ax.set_xlabel(r"$\mu$ (POI)")
ax.set_ylabel(r"$\mathrm{CL}_{s}$")
pyhf.contrib.viz.brazil.plot_results(ax, poi_vals, results)
fig.show()
**pyhf**
Expand Down

0 comments on commit 0e71f2f

Please sign in to comment.