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

Merge documentation updates with Main #320

Merged
merged 18 commits into from
Feb 26, 2025
Merged

Conversation

senthurayyappan
Copy link
Member

Description

This pull request includes several updates to the documentation and enhancements to the check_actuator decorators in the opensourceleg package. The most important changes are the addition of new module references in the documentation, reorganization of the mkdocs.yml file, and the addition of detailed docstrings to the decorators.

Documentation updates:

mkdocs.yml reorganization:

  • mkdocs.yml: Reorganized the navigation structure to categorize modules under specific headings.
  • Added syntax highlighting and additional markdown extensions. [1] [2]

Enhancements to check_actuator decorators:

  • opensourceleg/actuators/decorators.py: Added detailed docstrings to the check_actuator_connection, check_actuator_open, and check_actuator_stream decorators to provide better clarity on their functionality and usage. [1] [2] [3]

Related Issue

Type of Change

  • 📚 Examples / docs / tutorials / dependencies update
  • 🔧 Bug fix (non-breaking change which fixes an issue)
  • 🥂 Improvement (non-breaking change which improves an existing feature)
  • 🚀 New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 🔐 Security fix

Checklist

  • I've read the CODE_OF_CONDUCT.md document.
  • I've read the CONTRIBUTING.md guide.
  • I've updated the code style using make codestyle.
  • I've written tests for all new methods and classes that I created.
  • I've written the docstring in Google format for all the methods and classes that I used.

@senthurayyappan senthurayyappan self-assigned this Feb 26, 2025

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:
@senthurayyappan senthurayyappan merged commit 5553096 into main Feb 26, 2025
14 checks passed
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