Skip to content

Commit

Permalink
Docstring fixes for #431
Browse files Browse the repository at this point in the history
  • Loading branch information
richardjgowers committed Jan 15, 2016
1 parent 18a8813 commit e9daccb
Showing 1 changed file with 13 additions and 16 deletions.
29 changes: 13 additions & 16 deletions package/MDAnalysis/topology/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,19 @@
class TopologyReader(IObase):
"""Base class for topology readers
All topology readers must:
* Be initialised with a filename
* Return a struct dict by calling their parse function
Parameters
----------
filename : str
name of the topology file
universe : Universe, optional
Supply a Universe to the Parser. This then passes it to the
atom instances that are created within parsers.
kwargs : optional
Other keyword arguments that can vary with the specific format.
These are stored as self.kwargs
All topology readers must define a `parse` method which
returns a topology dict.
Raises
------
Expand All @@ -62,19 +72,6 @@ def __init__(cls, name, bases, classdict):
_PARSERS[f] = cls

def __init__(self, filename, universe=None, **kwargs):
"""Standard arguments for a TopologyReader:
Parameters
----------
filename : str
name of the topology file
universe : Universe, optional
Supply a Universe to the Parser. This then passes it to the
atom instances that are created within parsers.
kwargs : optional
Other keyword arguments that can vary with the specific format.
These are stored as self.kwargs
"""
self.filename = filename
self._u = universe
self.kwargs = kwargs
Expand Down

0 comments on commit e9daccb

Please sign in to comment.