Skip to content

Commit

Permalink
Merge pull request MDAnalysis#910 from MDAnalysis/issue-733-natomsdoc
Browse files Browse the repository at this point in the history
better documentation for Reader API and n_atoms kwarg
  • Loading branch information
jbarnoud authored Jul 22, 2016
2 parents a30fe16 + 28d8573 commit 5e79744
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions package/MDAnalysis/coordinates/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -420,12 +420,14 @@
``__init__(filename, **kwargs)``
open *filename*; other *kwargs* are processed as needed and the
Reader is free to ignore them. Typically, MDAnalysis supplies as
much information as possible to the Reader in `kwargs`; at the moment the
following data are supplied in keywords when a trajectory is loaded from
within :class:`MDAnalysis.Universe`:
- *n_atoms*: the number of atoms (known from the topology)
Reader is free to ignore them. Typically, when MDAnalysis creates
a Reader from :class:`MDAnalysis.Universe` it supplies as much
information as possible in `kwargs`; at the moment the following
data are supplied:
- *n_atoms*: the number of atoms from the supplied topology. This is
not required for all readers and can be ignored if not
required.
``__iter__()``
allow iteration from beginning to end::
Expand Down

0 comments on commit 5e79744

Please sign in to comment.