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

Minor code mistake in documentation #441

Open
Jibrangit opened this issue Mar 21, 2024 · 2 comments
Open

Minor code mistake in documentation #441

Jibrangit opened this issue Mar 21, 2024 · 2 comments

Comments

@Jibrangit
Copy link

I am not sure how this happened, but on the demos page http://docs.ros.org/en/melodic/api/py_trees/html/demos.html#id1 , in the code used for the various demos, the lines of code for returning the status is invalid. Instead of new_status = py_trees.Status.SUCCESS it should be new_status = py_trees.common.Status.SUCCESS.

This is ofcourse the case in the script that's located in the pip package and the script that executes the main() in action.py runs as expected. I only discovered this error because I copy-pasted the code and ran it as I wanted to tweak around.

@Jibrangit Jibrangit changed the title MInor code mistake in documentation Minor code mistake in documentation Mar 21, 2024
@Jibrangit
Copy link
Author

Jibrangit commented Mar 21, 2024

Actually, proceeding through the demos, I find plenty of mistakes in the code used in the documentation. At this point, I would put a disclaimer to NOT COPY the code directly from the documentation webpage.

@sea-bass
Copy link
Collaborator

Rather than a disclaimer, you're welcome to contribute fixes to the documentation as you see them! That would be much more helpful.

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

No branches or pull requests

2 participants