Skip to content

Commit 5951c5a

Browse files
Add FAQ on how to typeset 'pyhf' (#782)
* Add FAQ on how to typeset the name "pyhf" in journals
1 parent 140fb65 commit 5951c5a

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/faq.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,23 @@ If you are unable to get a Python 3 runtime, versioned Docker images of ``pyhf``
4848

4949
Once you have Python 3 installed, see the :ref:`installation` page to get started.
5050

51+
How is ``pyhf`` typeset?
52+
~~~~~~~~~~~~~~~~~~~~~~~~
53+
54+
As you may have guessed from this page, ``pyhf`` is typeset in all lowercase.
55+
This is largely historical, as the core developers had just always typed it that way and it seemed a bit too short of a library name to write as ``PyHF``.
56+
When typesetting in LaTeX the developers recommend introducing the command
57+
58+
.. code-block:: latex
59+
60+
\newcommand{\pyhf}{\texttt{pyhf}}
61+
62+
If the journal you are publishing in requires you to use ``textsc`` for software names it is okay to instead use
63+
64+
.. code-block:: latex
65+
66+
\newcommand{\pyhf}{\textsc{pyhf}}
67+
5168
Troubleshooting
5269
---------------
5370

0 commit comments

Comments
 (0)