Skip to content

Commit 7c3ba2e

Browse files
docs: Add Stack Overflow question section (#759)
* Add questions section for Stack Overflow [pyhf] tag to README and FAQs
1 parent d7b54e6 commit 7c3ba2e

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,18 @@ To uninstall run
111111
python -m pip uninstall pyhf
112112
```
113113

114+
## Questions
115+
116+
If you have a question about the use of `pyhf` not covered in [the documentation](https://scikit-hep.org/pyhf/), please ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/pyhf) with the `[pyhf]` tag, which the `pyhf` dev team [watches](https://stackoverflow.com/questions/tagged/pyhf?sort=Newest&filters=NoAcceptedAnswer&edited=true).
117+
118+
<p align="center">
119+
<a href="https://stackoverflow.com/questions/tagged/pyhf">
120+
<img src="https://cdn.sstatic.net/Sites/stackoverflow/company/img/logos/so/so-logo.png" alt="Stack Overflow pyhf tag" width="50%"/>
121+
</a>
122+
</p>
123+
124+
If you believe you have found a bug in `pyhf`, please report it in the [GitHub Issues](https://github.com/scikit-hep/pyhf/issues/new?template=Bug-Report.md&labels=bug&title=Bug+Report+:+Title+Here).
125+
114126
## Citation
115127

116128
As noted in [Use and Citations](https://scikit-hep.org/pyhf/citations.html), the preferred BibTeX entry for citation of `pyhf` is

docs/faq.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,20 @@ Frequently Asked Questions about :code:`pyhf` and its use.
66
Questions
77
---------
88

9+
Where can I ask questions about ``pyhf`` use?
10+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11+
If you have a question about the use of ``pyhf`` not covered in the `documentation <https://scikit-hep.org/pyhf/>`__, please ask a question on `Stack Overflow <https://stackoverflow.com/questions/tagged/pyhf>`__ with the ``[pyhf]`` tag, which the ``pyhf`` dev team `watches <https://stackoverflow.com/questions/tagged/pyhf?sort=Newest&filters=NoAcceptedAnswer&edited=true>`__.
12+
13+
.. raw:: html
14+
15+
<p align="center">
16+
<a href="https://stackoverflow.com/questions/tagged/pyhf">
17+
<img src="https://cdn.sstatic.net/Sites/stackoverflow/company/img/logos/so/so-logo.png" alt="Stack Overflow pyhf tag" width="50%"/>
18+
</a>
19+
</p>
20+
21+
If you believe you have found a bug in ``pyhf``, please report it in the `GitHub Issues <https://github.com/scikit-hep/pyhf/issues/new?template=Bug-Report.md&labels=bug&title=Bug+Report+:+Title+Here>`__.
22+
923
Is it possible to set the backend from the CLI?
1024
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1125

0 commit comments

Comments
 (0)