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.

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

Docker command line and documentation typos #713

Closed
katiebreivik opened this issue Nov 24, 2021 · 2 comments · Fixed by #716
Closed

Docker command line and documentation typos #713

katiebreivik opened this issue Nov 24, 2021 · 2 comments · Fixed by #716

Comments

@katiebreivik
Copy link

katiebreivik commented Nov 24, 2021

This issue is submitted as part of the JOSS review #3838

The Docker documentation has a typo in the options for specifying the number of systems to evolve when running via the command line

To Reproduce
Steps to reproduce the behavior:
Running in the Docker via the command line following the docs (https://compas.readthedocs.io/en/latest/pages/User%20guide/Running%20COMPAS/running-via-docker-running.html#via-the-command-line):

docker run                                  \
    --rm                                    \
    -it                                     \
    -v $(pwd)/compas-logs:/app/COMPAS/logs  \
    teamcompas/compas                       \
    bin/COMPAS                              \
    --number-of-binaries=5                  \
    --output-path=/app/COMPAS/logs

I expect this to run seamlessly, but get an error due to a typo in the option specifier: --number-of-binaries=5

Based on output from a --help run, I think this should be --number-of-systems=5 which runs as expected.

@katiebreivik katiebreivik changed the title Docker command line documentation typo Docker command line documentation typo severity_minor Nov 24, 2021
@katiebreivik katiebreivik changed the title Docker command line documentation typo severity_minor Docker command line documentation typo Nov 24, 2021
@katiebreivik
Copy link
Author

One more quick typo: In compile-time configuration: constanst.h --> constants.h

@katiebreivik katiebreivik changed the title Docker command line documentation typo Docker command line and documentation typos Nov 24, 2021
ilyamandel added a commit that referenced this issue Nov 25, 2021
@ilyamandel
Copy link
Collaborator

Thank you, @katiebreivik ! PR #716 created to address this.

@reinhold-willcox reinhold-willcox linked a pull request Nov 25, 2021 that will close this issue
reinhold-willcox pushed a commit that referenced this issue Nov 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants