search

glotzerlab / hoomd-blue

Molecular dynamics and Monte Carlo soft matter simulation on GPUs.
http://glotzerlab.engin.umich.edu/hoomd-blue
BSD 3-Clause "New" or "Revised" License
329 stars 127 forks source link

Review wall documentation #181

Closed joaander closed 8 years ago

joaander commented 8 years ago

Original report by me.

At least wall.group defines a parameter name where none exists.

joaander commented 8 years ago

Original comment by JamesP (Bitbucket: jproc, GitHub: j-proc).

If you mean in the examples, it looks to me that if we were to add from hoomd.md import wall to the top of each example we could resolve it quickly without cluttering too much. Is this what you meant?

joaander commented 8 years ago

No, I mean that the wall.group documentation http://hoomd-blue.readthedocs.io/en/stable/module-md-wall.html#hoomd.md.wall.group documents a parameter named "name":

name (str) – Name of the wall structure (string, defaults to empty string).

but wall.group does not accept such a parameter. I'm not sure if there are other typos like that in the docs or not.

joaander commented 8 years ago

Original comment by JamesP (Bitbucket: jproc, GitHub: j-proc).

Oh I see. Yes that's my fault, I remember removing that. If I remember correctly it was for metadata/restart purposes but the way things worked out it was unnecessary. I should have removed the documentation, apologies.

joaander commented 8 years ago

Fix typo in md.walls documentation.

fixes #181