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

[BUG]: SimulationInit and SimulationPeriodic do not show up in API documentation #130

Open
daltzctr opened this issue Jan 6, 2025 · 2 comments

Comments

@daltzctr
Copy link

daltzctr commented Jan 6, 2025

Problem description

https://robotpy.readthedocs.io/projects/robotpy/en/latest/wpilib/IterativeRobotBase.html#wpilib.IterativeRobotBase is missing SimulationInit() and SimulationPeriodic()

These are publicly defined in https://github.wpilib.org/allwpilib/docs/release/cpp/classfrc_1_1_iterative_robot_base.html, but the robotpy implementation has these marked private, which causes it to not show up in API documentation.

Operating System

Windows

Installed Python Packages

No response

Reproducible example code

No response

@daltzctr daltzctr changed the title [BUG]: IterativeRobotBase is missing SimulationInit and SimulationPeriodic [BUG]: SimulationInit and SimulationPeriodic do not show up in API documentation Jan 6, 2025
@virtuald
Copy link
Member

virtuald commented Jan 6, 2025

This is by design, RobotPy users should implement simulation related functionality in physics.py instead. See https://robotpy.readthedocs.io/projects/pyfrc/en/stable/physics.html#enabling-physics-support

@virtuald
Copy link
Member

virtuald commented Jan 6, 2025

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

No branches or pull requests

2 participants