-
Notifications
You must be signed in to change notification settings - Fork 218
/
variables.txt
23 lines (17 loc) · 1.27 KB
/
variables.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
.. this file contains are the "replace" variables for feature names or other teams that either
.. take a lot of time to type or are likely to change in the future. Instead of hard-coding the
.. word or phrase in source files, you can include the variable surrounded by pipes (|).
.. the convention is to use the suffix _l for the long form and _s for the short form. Where
.. capitalization varies based on position in the sentence (for example, if the term includes an
.. article), use lowercase and capital letters after the underscore. For supported third-party
.. software, use the "supp" variable to refer to the currently supported version, which will be
.. updated in the future; use the numbered variable to refer specifically to a version that
.. will not be updated.
.. you cannot nest glossary terms and replace variables, so if you need to define a term that may
.. change in the future, use the :term: on first use, and then use the replace variable for each
.. subsequent use. If the term changes, you will only need to manually update the :term: links.
.. |IDM_l| replace:: Institute for Disease Modeling (IDM)
.. |IDM_s| replace:: IDM
.. |Cov_l| replace:: COVID-19 Agent-based Simulator (Covasim)
.. |Cov_s| replace:: Covasim
.. |Python_supp| replace:: Python >= 3.6 (64-bit)