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

SyntheSimJava Documentation #1094

Merged
merged 11 commits into from
Aug 22, 2024
Merged

SyntheSimJava Documentation #1094

merged 11 commits into from
Aug 22, 2024

Conversation

azaleacolburn
Copy link
Contributor

@azaleacolburn azaleacolburn commented Aug 13, 2024

Description

Documentation for SyntheSimJava

Let me know if anything else should be added.

No JIRA Issue

@azaleacolburn azaleacolburn added documentation codesim Code simulation related task. labels Aug 13, 2024
@azaleacolburn azaleacolburn self-assigned this Aug 13, 2024
@azaleacolburn azaleacolburn changed the base branch from prod to dev August 13, 2024 22:56
@azaleacolburn azaleacolburn marked this pull request as ready for review August 19, 2024 19:02
@azaleacolburn azaleacolburn requested review from HunterBarclay and a team as code owners August 19, 2024 19:02
@azaleacolburn azaleacolburn requested review from a-crowell, LucaHaverty, PepperLola and BrandonPacewic and removed request for a team August 19, 2024 19:02
@azaleacolburn azaleacolburn changed the base branch from dev to prod August 19, 2024 19:02
@azaleacolburn azaleacolburn requested a review from a team as a code owner August 19, 2024 19:02
@azaleacolburn azaleacolburn changed the base branch from prod to dev August 19, 2024 19:02
Copy link
Member

@BrandonPacewic BrandonPacewic left a comment

Choose a reason for hiding this comment

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

Copy link
Contributor

@a-crowell a-crowell left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@PepperLola PepperLola left a comment

Choose a reason for hiding this comment

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

I think it's worth changing the Java comments to use the Javadoc format so people who use the library can get intellisense native to their editor.

azaleacolburn and others added 2 commits August 21, 2024 09:15
…revrobotics/CANSparkMax.java

Co-authored-by: PepperLola <PepperLola@users.noreply.github.com>
…revrobotics/SparkAbsoluteEncoder.java

Co-authored-by: PepperLola <PepperLola@users.noreply.github.com>
Copy link
Contributor

@PepperLola PepperLola left a comment

Choose a reason for hiding this comment

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

I think it looks good now. I made some changes that you're free to revert if you want.

Edit: It looks like I introduced a merge conflict by adding a class comment. I think that should stay there but maybe the import should be removed if it was added in this PR?

Copy link
Member

@BrandonPacewic BrandonPacewic left a comment

Choose a reason for hiding this comment

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

I think it looks good now. I made some changes that you're free to revert if you want.

Edit: It looks like I introduced a merge conflict by adding a class comment. I think that should stay there but maybe the import should be removed if it was added in this PR?

The merge conflict was just due to this branch not being up to date with dev where that commented import was already removed.

Looks good to go as long as @azaleacolburn is ok with the pushed changes ✅

@HunterBarclay HunterBarclay merged commit 4382dfd into dev Aug 22, 2024
14 checks passed
@HunterBarclay HunterBarclay deleted the colbura/1845/sythesim-docs branch August 22, 2024 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codesim Code simulation related task. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants