From 28d85731096bced751cb09768b5e522869745600 Mon Sep 17 00:00:00 2001 From: Richard Gowers Date: Fri, 22 Jul 2016 11:21:39 +0100 Subject: [PATCH] better documentation for Reader API and n_atoms kwarg --- package/MDAnalysis/coordinates/__init__.py | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/package/MDAnalysis/coordinates/__init__.py b/package/MDAnalysis/coordinates/__init__.py index 1b01098ca8d..4ce89432ef5 100644 --- a/package/MDAnalysis/coordinates/__init__.py +++ b/package/MDAnalysis/coordinates/__init__.py @@ -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::