Skip to content

Commit

Permalink
Hbond analysis: fixed docs (stated wrong defaults for updating)
Browse files Browse the repository at this point in the history
  • Loading branch information
orbeckst committed May 12, 2017
1 parent 2cf191a commit 245560e
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions package/MDAnalysis/analysis/hbonds/hbond_analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -456,17 +456,19 @@ def __init__(self, universe, selection1='protein', selection2='all', selection1_
Selection string for first selection ['protein']
selection2 : str (optional)
Selection string for second selection ['all']
selection1_type : str (optional)
selection1_type : {"donor", "acceptor", "both"} (optional)
Selection 1 can be 'donor', 'acceptor' or 'both'. Note that the
value for `selection1_type` automatically determines how
`selection2` handles donors and acceptors: If `selection1` contains
'both' then `selection2` will also contain *both*. If `selection1`
'both' then `selection2` will also contain 'both'. If `selection1`
is set to 'donor' then `selection2` is 'acceptor' (and vice versa).
['both'].
update_selection1 : bool (optional)
Update selection 1 at each frame? [``False``]
Update selection 1 at each frame? Setting to ``False`` is recommended
for any static selection to increase performance. [``True``]
update_selection2 : bool (optional)
Update selection 2 at each frame? [``False``]
Update selection 2 at each frame? Setting to ``False`` is recommended
for any static selection to increase performance. [``True``]
filter_first : bool (optional)
Filter selection 2 first to only atoms 3 * `distance` away [``True``]
distance : float (optional)
Expand Down

0 comments on commit 245560e

Please sign in to comment.