Skip to content

Commit

Permalink
Use reST syntax for inline code
Browse files Browse the repository at this point in the history
Previously markdown syntax was used but that gets rendered as italics in
the docs.
  • Loading branch information
victorlin committed Jun 28, 2024
1 parent 0f2441e commit 5b4d696
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions augur/import_/beast.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

def register_parser(parent_subparsers):
"""
Arguments available to `augur import beast`
Arguments available to ``augur import beast``
"""
beast_parser = parent_subparsers.add_parser('beast', help="Import beast analysis")
beast_parser.add_argument("--beast", help=SUPPRESS, default=True) # used to disambiguate subcommands
Expand All @@ -42,7 +42,7 @@ def parse_beast_tree(data, tipMap, verbose=False):
The (really long) line in the NEXUS file beginning with "tree", pruned
to start at the first "(" character.
tipMap : dict
Mapping of tips (as encoded in `data`) to their names
Mapping of tips (as encoded in ``data``) to their names
verbose : bool
Should output be printed?
Expand Down Expand Up @@ -350,7 +350,7 @@ def find_most_recent_tip(tree, tip_date_regex, tip_date_format, tip_date_delimet
The format of the extracted date.
(e.g. "%Y-%m-%d" goes with "2012-10-30")
tip_date_delimeter : str
The delimeter in `tip_date_format`
The delimeter in ``tip_date_format``
Raises
------
Expand Down Expand Up @@ -514,8 +514,8 @@ def compute_entropies_for_discrete_traits(tree):

def print_what_to_do_next(nodes, mcc_path, tree_path, node_data_path):
"""
Print a suggested `auspice_config.json` file, which the user will have to configure
and provide to `augur export`. There is not enough information in a MCC tree to do
Print a suggested ``auspice_config.json`` file, which the user will have to configure
and provide to ``augur export``. There is not enough information in a MCC tree to do
this automatically.
"""

Expand Down

0 comments on commit 5b4d696

Please sign in to comment.