Skip to content

Commit

Permalink
Fix inline literals
Browse files Browse the repository at this point in the history
  • Loading branch information
veghp committed Sep 14, 2020
1 parent a6bcb93 commit b5f4f05
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,17 +71,17 @@ To write the sequences down as Genbank records, with annotations:
from crazydoc import records_to_genbank
records_to_genbank(biopython_records)
Note that `records_to_genbank()` will truncate the record name to 20 characters,
to fit in the GenBank format. Additionally, slashes (`/`) will be replaced with
hyphens (`-`) in the filenames. To read protein sequences, pass `is_protein=True`:
Note that ``records_to_genbank()`` will truncate the record name to 20 characters,
to fit in the GenBank format. Additionally, slashes (``/``) will be replaced with
hyphens (``-``) in the filenames. To read protein sequences, pass ``is_protein=True``:

.. code:: python
biopython_records = parse_doc_file(protein_path, is_protein=True)
This will return *protein* records, which will be saved with a GenPept extension
(.gp) by `records_to_genbank(biopython_records, is_protein=True)`,
unless specified otherwise with `extension=`.
(.gp) by ``records_to_genbank(biopython_records, is_protein=True)``,
unless specified otherwise with ``extension=``.


Installation
Expand Down

0 comments on commit b5f4f05

Please sign in to comment.