Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Incorrect documentation of shape parameters #3566

Closed
jngrad opened this issue Mar 6, 2020 · 1 comment · Fixed by #3567
Closed

Incorrect documentation of shape parameters #3566

jngrad opened this issue Mar 6, 2020 · 1 comment · Fixed by #3567
Assignees
@jngrad
Labels
Documentation
Milestone
Espresso 4.1.3

Comments

@jngrad
Copy link
Member

jngrad commented Mar 6, 2020

The documentation of shapes Cylinder and SpheroCylinder incorrectly states the length parameter represents half the cylinder length:

espresso/doc/sphinx/constraints.rst

Lines 249 to 250 in 0436a79

The resulting surface is a cylinder with center ``center`` and radius ``radius``.
The ``length`` parameter is **half** of the cylinder length.

This was only true in the Tcl version, it was changed in the 4.0.0 release (6a1ff85).

Reported by @dpo854 in #3555 (comment).
@jngrad jngrad added this to the Espresso 4.1.3 milestone Mar 6, 2020
@jngrad jngrad self-assigned this Mar 6, 2020
@jngrad
Copy link
Member Author

jngrad commented Mar 6, 2020

The Rhomboid shape is also incorrectly documented.

@jngrad jngrad changed the title Documentation of cylinder shapes is wrong Incorrect documentation of shape parameters Mar 6, 2020
@jngrad jngrad mentioned this issue Mar 6, 2020
Merged
@kodiakhq kodiakhq bot closed this as completed in #3567 Mar 6, 2020
kodiakhq bot added a commit that referenced this issue Mar 6, 2020
@kodiakhq
Cleanup and restructure documentation, fix errors (#3567)
729a677 
Description of changes:
- normalize filenames in tutorial 06 (fixes #3487)
- fix errors in documentation of shape parameters (fixes #3566)
- fix broken Sphinx syntax
   - broken links to C++ methods declared in the `Methods` section of numpydoc docstrings
   - broken definition list in shapes documentation
   - incorrect reStructureText syntax
- restructure section titles in installation instructions and shapes
- improve documentation of external features, such as H5MD (see today's mailing list email "H5md not available"), and remove documentation of removed features, e.g. `OIF_GLOBAL_FORCES`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jngrad jngrad

Labels
Documentation
Projects
None yet
Milestone
Espresso 4.1.3
Development

Successfully merging a pull request may close this issue.

Cleanup and restructure documentation, fix errors jngrad/espresso
1 participant
@jngrad