Migrate Python docs API names to snake case - #3327
Open
virtuald wants to merge 3 commits into
Open
Conversation
Collaborator
|
snake_case isn't in a robotpy release yet, right? Usually we'd wait to merge docs until there's a release |
Collaborator
|
Is there a way to check how names actually got converted in robotpy? For example in this PR PIDController wasn't changed, but rightPID was changed to right_pid |
Member
Author
|
You can look at the pyi files in the wheels that were published for 2027.0.0a6.post4, or look at the latest documentation on readthedocs (for example https://robotpy.readthedocs.io/projects/robotpy/en/latest/wpimath/PIDController.html#wpimath.PIDController.set_p) |
Collaborator
|
I got tripped up by the fact that only some things are snake_case, class names are not |
Collaborator
|
There isn't really a python section in the changelog, but this is definitely important enough to be added to the changelog |
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
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.
AI-generated, but I manually reviewed and spot checked some API. I told GPT to not check/update remote literal includes since I think there's already a tool for doing that?
Includes #3326 which did update some remote literal includes.