Skip to content

Commit

Permalink
Add note on lowercase module names
Browse files Browse the repository at this point in the history
  • Loading branch information
hejamu committed Mar 21, 2024
1 parent 4a34e33 commit ffd0a80
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/mdacli/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@
A command line interface (CLI) to the analysis modules of MDAnalysis.
The modules are all structured as part of a single mdacli wrapper, and invoked
with commands like `mda RMSD`. This command uses the class
:class:`MDAnalysis.analysis.rms.RMSD` for calculating the RMSD.
with commands like `mda RMSD` (The lowercase `mda rmsd` is also supported).
This command uses the class :class:`MDAnalysis.analysis.rms.RMSD` for
calculating the RMSD.
Documentation for each module can be found at the respective sections on the
`MDAnalysis Documentation`_, as well as
`mda command -h`.
Expand Down

0 comments on commit ffd0a80

Please sign in to comment.