Skip to content

Migrate Python docs API names to snake case - #3327

Open
virtuald wants to merge 3 commits into
wpilibsuite:mainfrom
virtuald:snake_case
Open

Migrate Python docs API names to snake case#3327
virtuald wants to merge 3 commits into
wpilibsuite:mainfrom
virtuald:snake_case

Conversation

@virtuald

Copy link
Copy Markdown
Member

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.

@sciencewhiz

Copy link
Copy Markdown
Collaborator

snake_case isn't in a robotpy release yet, right? Usually we'd wait to merge docs until there's a release

@sciencewhiz

Copy link
Copy Markdown
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

@virtuald

Copy link
Copy Markdown
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)

@sciencewhiz

Copy link
Copy Markdown
Collaborator

I got tripped up by the fact that only some things are snake_case, class names are not

@sciencewhiz

Copy link
Copy Markdown
Collaborator

There isn't really a python section in the changelog, but this is definitely important enough to be added to the changelog

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.

2 participants