Add comments and javadocs to match ctre code - #80
Merged
Conversation
|
🌐 Preview URL: https://pr-80.frcsoftware.pages.dev |
samfreund
requested changes
Jul 6, 2026
samfreund
left a comment
samfreund
left a comment
Member
There was a problem hiding this comment.
Point of clarification, docstrings are for python, javadoc is what we'd call it for Java.
samfreund
force-pushed
the
update-docstrings
branch
from
July 6, 2026 04:53
9627e99 to
08dd9f5
Compare
Spaceman113138
marked this pull request as ready for review
July 6, 2026 04:57
Member
Address please |
Spaceman113138
changed the title
Contributor
Author
The new title should be more accurate. |
roboteer5291
added
REV
Adrianamm
previously approved these changes
Aug 26, 2026
8 tasks
ArchdukeTim
suggested changes
Aug 26, 2026
Adrianamm
approved these changes
Aug 30, 2026
zachwaffle4
added a commit
to ftcsoftware/ftcsoftware.org
that referenced
this pull request
Aug 30, 2026
* Stage1a auto + additonal motors (frcsoftware#194) ## Description Adds stage 1a curriculum for programing a simple auto as well as progiraming the IntakeLauncher and Feeder motors. Makes progress on frcsoftware#13 . Todo: - [x] Video + text on running the simple auto - [x] Talk about FuelSim - [x] Update FuelSim to use `periodic()` over `update()` - [x] Video + text on AScope graph with additonal motors - [x] Video + text on Ascope 3d with additional motors ## Meta Merge checklist: - [x] Pull Request title is [short, imperative summary](https://cbea.ms/git-commit/) of proposed changes - [x] The description documents the _what_ and _why_, including events that led to this PR - [x] Pull Request has been [linted and formatted](https://frcsoftware.org/contribution/styleguide/#linting-and-formatting) and follows the [styleguide](https://frcsoftware.org/contribution/styleguide) --------- Co-authored-by: Adriana <16786568+Adrianamm@users.noreply.github.com> * Stage 1B: Explain what a task is for/will accomplish (frcsoftware#183) ## Description What changed? Why? (the code + comments should speak for itself on the "how") Some tasks failed to explain what they are for/what they accomplish. This PR adds extra lines to fix that. Draft for now as I only did a quick sweep and want other eyes to catch more locations. Closes frcsoftware#167. ## Meta Merge checklist: - [x] Pull Request title is [short, imperative summary](https://cbea.ms/git-commit/) of proposed changes - [x] The description documents the _what_ and _why_, including events that led to this PR - [x] Pull Request has been [linted and formatted](https://frcsoftware.org/contribution/styleguide/#linting-and-formatting) and follows the [styleguide](https://frcsoftware.org/contribution/styleguide) --------- Co-authored-by: Adriana <16786568+Adrianamm@users.noreply.github.com> * Fix AstroJS deprecation warnings (frcsoftware#201) PR frcsoftware#171 introduced a deprecated warning from the use of remarkRehype without specifying unified() as the markdown processor. This PR also bumps starlight-links-validator to the latest version to resolve a second deprecation warning. --------- Co-authored-by: Zach Harel <zach@zharel.me> * Stage 1A: Code snippet fixed and clarified text about main (frcsoftware#191) ## Description What changed? Why? (the code + comments should speak for itself on the "how") Code snippets for main.java didn't match so that was fixed. Also reworded the part about main to make it clear that it shouldn't be edited. Merge checklist: - [x] Pull Request title is [short, imperative summary](https://cbea.ms/git-commit/) of proposed changes - [x] The description documents the _what_ and _why_, including events that led to this PR - [x] Pull Request has been [linted and formatted](https://frcsoftware.org/contribution/styleguide/#linting-and-formatting) and follows the [styleguide](https://frcsoftware.org/contribution/styleguide) Co-authored-by: Zach Harel <zach@zharel.me> * Add comments and javadocs to match ctre code (frcsoftware#80) ## Description Adds the wpilib template comments and javadocs to the rev stage 1a code to match the ctre code. Result of this review: frcsoftware#51 (review) ## Meta Merge checklist: - [x] Pull Request title is [short, imperative summary](https://cbea.ms/git-commit/) of proposed changes - [x] The description documents the _what_ and _why_, including events that led to this PR - [x] Pull Request has been [linted and formatted](https://frcsoftware.org/contribution/styleguide/#linting-and-formatting) and follows the [styleguide](https://frcsoftware.org/contribution/styleguide) --------- Co-authored-by: Adriana <16786568+Adrianamm@users.noreply.github.com> * Minor clean ups in sidebar and course overview (frcsoftware#208) ## Description What changed? Why? (the code + comments should speak for itself on the "how") For Stage 0, Stage 1, Stage 1, Stage 1A and Stage 1B, the sidebar used the word "Introduction" for the overview. However, the overview page had a header which said "Stage # Overview". I adjusted it so instead of "Stage # Introduction" it is now "Stage # Overview". It's more consistent The Course overview got small updates, including: - The list for Stage 0 was out of date. That was updated to reflect what is currently in the stage 0 sidebar - It was "Stage1A" "Stage1B" but I added a space to keep it consistent. it's now "Stage 1A" and "Stage 1B" - The sentence for describing 1B was updated to better reflect what it is. also the flow of the setence didn't quite make sense before. `Add Command-Based programming, a file structure for programming FRC robots, to kitbot` vs `Learn Command-Based programming, a file structure for programming FRC robots, by adding it to code written in 1A.` - The link to Stage1 now directs to Stage1 overview. Before it did not ## Meta Merge checklist: - [x] Pull Request title is [short, imperative summary](https://cbea.ms/git-commit/) of proposed changes - [x] The description documents the _what_ and _why_, including events that led to this PR - [x] Pull Request has been [linted and formatted](https://frcsoftware.org/contribution/styleguide/#linting-and-formatting) and follows the [styleguide](https://frcsoftware.org/contribution/styleguide) --------- Co-authored-by: Zach Harel <zach@zharel.me> --------- Co-authored-by: Spaceman 11 <135277197+Spaceman113138@users.noreply.github.com> Co-authored-by: Adriana <16786568+Adrianamm@users.noreply.github.com> Co-authored-by: ハイドラ <thecomputer314@gmail.com> Co-authored-by: httphypixelnet <91695346+httphypixelnet@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds the wpilib template comments and javadocs to the rev stage 1a code to match the ctre code. Result of this review: #51 (review)
Meta
Merge checklist: