Skip to content

Commit

Permalink
updated API docs to link from assign_m13_to_scaffold method to M13Var…
Browse files Browse the repository at this point in the history
…iant enumerated type
  • Loading branch information
dave-doty committed Jan 15, 2021
1 parent bed7b3c commit 05e76b9
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions scadnano/scadnano.py
Original file line number Diff line number Diff line change
Expand Up @@ -413,11 +413,11 @@ class M13Variant(enum.Enum):
p7249 = "p7249"
""""Standard" variant of M13mp18; 7249 bases long, available from, for example
https://www.tilibit.com/collections/scaffold-dna/products/single-stranded-scaffold-dna-type-p7249
https://www.neb.com/products/n4040-m13mp18-single-stranded-dna
http://www.bayoubiolabs.com/biochemicat/vectors/pUCM13/
https://www.tilibit.com/collections/scaffold-dna/products/single-stranded-scaffold-dna-type-p7249
"""

p7560 = "p7560"
Expand All @@ -443,9 +443,9 @@ def m13(rotation: int = 5587, variant: M13Variant = M13Variant.p7249) -> str:
`GenBank <https://www.ncbi.nlm.nih.gov/nuccore/X02513.1>`_.
By default, returns the "standard" variant of consisting of 7249 bases, sold by companies such as
`New England Biolabs <https://www.neb.com/~/media/nebus/page%20images/tools%20and%20resources/interactive%20tools/dna%20sequences%20and%20maps/m13mp18_map.pdf>`_
and
`Tilibit <https://cdn.shopify.com/s/files/1/1299/5863/files/Product_Sheet_single-stranded_scaffold_DNA_type_7249_M1-10.pdf?14656642867652657391>`_.
and
`New England Biolabs <https://www.neb.com/~/media/nebus/page%20images/tools%20and%20resources/interactive%20tools/dna%20sequences%20and%20maps/m13mp18_map.pdf>`_
The actual M13 DNA strand itself is circular,
so assigning this sequence to the scaffold :any:`Strand` in a :any:`Design`
Expand Down Expand Up @@ -4346,7 +4346,8 @@ def strand(self, helix: int, offset: int) -> StrandBuilder:
return StrandBuilder(self, helix, offset)

def assign_m13_to_scaffold(self, rotation: int = 5587, variant: M13Variant = M13Variant.p7249) -> None:
"""Assigns the scaffold to be the sequence of M13: :py:func:`m13` with the given `rotation`.
"""Assigns the scaffold to be the sequence of M13: :py:func:`m13` with the given `rotation`
and :any:`M13Variant`.
Raises :any:`IllegalDesignError` if the number of scaffolds is not exactly 1.
"""
Expand Down

0 comments on commit 05e76b9

Please sign in to comment.