Skip to content

Commit

Permalink
Update ParameterHandler.add_parameter docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
mattwthompson committed Jun 2, 2021
1 parent 600ebb3 commit a58421a
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions openff/toolkit/typing/engines/smirnoff/parameters.py
Original file line number Diff line number Diff line change
Expand Up @@ -2063,11 +2063,15 @@ def add_parameter(
The SMIRKS pattern (if str) or index (if int) of the parameter directly after where
the new parameter will be added
Note that one of (parameter_kwargs, parameter) must be specified
Note that when `before` and `after` are both None, the new parameter will be appended
to the END of the parameter list.
Note that when `before` and `after` are both specified, the new parameter
will be added immediately after the parameter matching the `after` pattern or index.
Note the following behavior:
* Either `parameter_kwargs` or `parameter` must be specified.
* When `before` and `after` are both `None`, the new parameter will be appended
to the **END** of the parameter list.
* When `before` and `after` are both specified, the new parameter will be added immediately
after the parameter matching the `after` pattern or index.
* The order of parameters in a parameter list can have significant impacts on parameter assignment. For details,
see the [SMIRNOFF](https://open-forcefield-toolkit.readthedocs.io/en/latest/smirnoff.html#smirnoff-parameter-specification-is-hierarchical)
specification.
Examples
--------
Expand Down

0 comments on commit a58421a

Please sign in to comment.