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

Add javadoc for vision and parameter tools #68

Merged
merged 3 commits into from
Dec 9, 2024

Conversation

sleepyghost-zzz
Copy link
Contributor

Added 58 Javadocs for vision and parameter tools. They have detailed descriptions about they class and methods and link to other code snippets.

@sleepyghost-zzz sleepyghost-zzz self-assigned this Dec 8, 2024
@sleepyghost-zzz sleepyghost-zzz linked an issue Dec 8, 2024 that may be closed by this pull request
2 tasks
@linglejack06
Copy link
Member

@sleepyghost-zzz i actually just rewrote vision :( but i went ahead and added a lot of comments explaining the methods within code. Most of the methods are similar, so descriptions should be able to be copied over. But if you need to work on other javadocs i can add them to the vision here. @jkleiber what would you prefer?

@sleepyghost-zzz
Copy link
Contributor Author

@linglejack06 rip. I was told to work on parameter tools and vision javadocs and @Samson560915 would work on the other ones. We'll see what @jkleiber wants, i am fine with rewriting the vision stuff if need be. If you have written comments a lot of the descriptions can probably just be adjusted to fit what the method is doing.

@jkleiber
Copy link
Member

jkleiber commented Dec 8, 2024

@sleepyghost-zzz @linglejack06 let's just merge the javadoc updates and have Jack update the docs as needed

Copy link
Member

@jkleiber jkleiber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@PChild PChild merged commit ddc04e0 into main Dec 9, 2024
6 checks passed
@aidnem aidnem deleted the add-javadoc-for-vision-and-parameter-tools branch December 9, 2024 15:35
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 this pull request may close these issues.

Add javadoc docstrings to vision and parameter tools
4 participants