-
Notifications
You must be signed in to change notification settings - Fork 43
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
Merge documentation updates with Main #320
Merged
Merged
Conversation
This file contains 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
… control of dephy actuator
feature/documentation: Adding documentation and examples
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot reviewed 43 out of 43 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
opensourceleg/actuators/decorators.py:48
- The check_actuator_open decorator's docstring indicates that it raises an ActuatorConnectionException when the actuator is not open. Using the same exception as for connection issues could be confusing; consider defining and using a more specific exception (e.g., ActuatorOpenException) for clarity.
def check_actuator_open(func: Callable) -> Callable:
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.
Description
This pull request includes several updates to the documentation and enhancements to the
check_actuator
decorators in theopensourceleg
package. The most important changes are the addition of new module references in the documentation, reorganization of themkdocs.yml
file, and the addition of detailed docstrings to the decorators.Documentation updates:
docs/modules.md
: Removed the old module reference.docs/modules/actuators/actuators.md
: Added reference toopensourceleg.actuators.base
.docs/modules/actuators/dephy.md
: Added reference toopensourceleg.actuators.dephy
.docs/modules/actuators/moteus.md
: Added reference toopensourceleg.actuators.moteus
.docs/modules/actuators/tmotor.md
: Added reference toopensourceleg.actuators.tmotor
.docs/modules/collections/validators.md
: Added reference toopensourceleg.collections.validators
.docs/modules/control/compiled_controller.md
: Added reference toopensourceleg.control.compiled_controller
.docs/modules/control/state_machine.md
: Added reference toopensourceleg.control.state_machine
.docs/modules/logging.md
: Added reference toopensourceleg.logging
.docs/modules/robots/osl.md
: Added reference toopensourceleg.robots.osl
.docs/modules/robots/robots.md
: Added reference toopensourceleg.robots.base
.docs/modules/safety.md
: Added reference toopensourceleg.safety
.docs/modules/sensors/adc.md
: Added reference toopensourceleg.sensors.adc
.docs/modules/sensors/encoder.md
: Added reference toopensourceleg.sensors.encoder
.docs/modules/sensors/imu.md
: Added reference toopensourceleg.sensors.imu
.docs/modules/sensors/loadcell.md
: Added reference toopensourceleg.sensors.loadcell
.docs/modules/sensors/sensors_base.md
: Added reference toopensourceleg.sensors.base
.docs/modules/time.md
: Added reference toopensourceleg.time
.mkdocs.yml
reorganization:mkdocs.yml
: Reorganized the navigation structure to categorize modules under specific headings.Enhancements to
check_actuator
decorators:opensourceleg/actuators/decorators.py
: Added detailed docstrings to thecheck_actuator_connection
,check_actuator_open
, andcheck_actuator_stream
decorators to provide better clarity on their functionality and usage. [1] [2] [3]Related Issue
Type of Change
Checklist
CODE_OF_CONDUCT.md
document.CONTRIBUTING.md
guide.make codestyle
.