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

Documentation and Linter #253

Merged
merged 4 commits into from
Oct 20, 2024
Merged

Documentation and Linter #253

merged 4 commits into from
Oct 20, 2024

Conversation

webdjoe
Copy link
Owner

@webdjoe webdjoe commented Oct 20, 2024

No changes to API or structure

Incorporated documentation for MkDocs into docstrings for the following modules:

  • helpers
  • vesync
  • vesyncbasedevice
  • vesyncbulb
  • vesyncfan (WIP)

Start transitioning to Ruff for linting - made first set of stylistic and code fixes

Fix type annotations

Update docs in vesync, vesyncbaseobject and vesyncbulb.

Add ruff.toml and fix preliminary linting errors
Start transition to Ruff and improve docstrings
Add too-many-positional arguments exception. This error will be addressed in the next release.
@webdjoe webdjoe merged commit 2a9b7a0 into master Oct 20, 2024
5 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.

1 participant