Skip to content

Commit

Permalink
Added extensions to savers doc string (#1146)
Browse files Browse the repository at this point in the history
* Added extensions to savers doc string

* Update mbuild/compound.py

---------

Co-authored-by: Co Quach <[email protected]>
  • Loading branch information
CalCraven and daico007 authored Sep 26, 2023
1 parent 468028b commit d94cc3a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion mbuild/compound.py
Original file line number Diff line number Diff line change
Expand Up @@ -2890,7 +2890,9 @@ def save(
filename : str
Filesystem path in which to save the trajectory. The extension or
prefix will be parsed and control the format. Supported extensions:
'hoomdxml', 'gsd', 'gro', 'top', 'lammps', 'lmp', 'mcf'
'hoomdxml', 'gsd', 'gro', 'top', 'lammps', 'lmp', 'mcf', 'pdb', 'xyz',
'json', 'mol2', 'sdf', 'psf'. See parmed/structure.py for more
information on savers.
show_ports : bool, optional, default=False
Save ports contained within the compound.
forcefield_files : str, optional, default=None
Expand Down
4 changes: 3 additions & 1 deletion mbuild/conversion.py
Original file line number Diff line number Diff line change
Expand Up @@ -978,7 +978,9 @@ def save(
filename : str
Filesystem path in which to save the trajectory. The extension or prefix
will be parsed and control the format. Supported extensions are:
'hoomdxml', 'gsd', 'gro', 'top', 'lammps', 'lmp', 'mcf'.
'hoomdxml', 'gsd', 'gro', 'top', 'lammps', 'lmp', 'mcf', 'xyz', 'pdb',
'sdf', 'mol2', 'psf'. See parmed/structure.py for more information on
savers.
show_ports : bool, optional, default=False
Save ports contained within the compound.
forcefield_files : str, optional, default=None
Expand Down

0 comments on commit d94cc3a

Please sign in to comment.