djay0529 / mdanalysis

Automatically exported from code.google.com/p/mdanalysis
0 stars 0 forks source link

Coordinate fitting and alignment docs #180

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
For rmsd docs on this page: 
http://mdanalysis.googlecode.com/git-history/develop/package/doc/html/documentat
ion_pages/analysis/align.html?highlight=rmsd#module-MDAnalysis.analysis.align

Suggestions:

1) Replace from X import * type statements with safer / more explicit namespace 
usage (and so the end user knows the precise origin module if they do not wish 
to import *).
2) Split the callable functions / classes on this page and their corresponding 
example usage cases to individual pages--many of the examples are simple 
demonstrations of a function defined further down in the doc. This doesn't mean 
we can't still have a general tutorial page for the module as well.

Original issue reported on code.google.com by tyler.je.reddy@gmail.com on 27 Apr 2014 at 5:55