Skip to content

Commit

Permalink
[DOCS] document TransTable.size only via autodoc
Browse files Browse the repository at this point in the history
  • Loading branch information
orbeckst committed Nov 2, 2021
1 parent 46d38a8 commit 86d9ff6
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions package/MDAnalysis/core/topology.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ def make_downshift_arrays(upshift, nparents):
"""
if not len(upshift):
return np.array([], dtype=object)

order = np.argsort(upshift)

upshift_sorted = upshift[order]
Expand Down Expand Up @@ -178,8 +178,6 @@ class TransTable(object):
number of residues in topology
n_segments : int
number of segments in topology
size
tuple describing the shape of the TransTable
"""
def __init__(self,
n_atoms, n_residues, n_segments, # Size of tables
Expand Down Expand Up @@ -214,7 +212,9 @@ def copy(self):

@property
def size(self):
"""The shape of the table, (n_atoms, n_residues, n_segments)"""
"""The shape of the table as tuple
``(n_atoms, n_residues, n_segments)``.
"""
return (self.n_atoms, self.n_residues, self.n_segments)

def atoms2residues(self, aix):
Expand Down Expand Up @@ -575,4 +575,4 @@ def add_Segment(self, **new_attrs):
attr.values = np.concatenate([attr.values, np.array([newval])])

return segidx

0 comments on commit 86d9ff6

Please sign in to comment.