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.

Sign up for GitHub

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

Jump to bottom

Add missing docstrings #78

Closed
KapJI opened this issue Mar 9, 2021 · 2 comments · Fixed by #89
Closed

Add missing docstrings #78

KapJI opened this issue Mar 9, 2021 · 2 comments · Fixed by #89
Labels
documentation Improvements or additions to documentation

Comments

@KapJI
Copy link
Collaborator

KapJI commented Mar 9, 2021 •
edited

Problem

Let's enforce better documentation and add missing docstrings.

How to do this

Remove these lines from pyproject.yaml and make sure poetry run pylint custom_components/google_home finished with no warnings.

    "missing-class-docstring",
    "missing-function-docstring",
    "missing-module-docstring",

Can anyone take this?
@leikoilja leikoilja added the documentation Improvements or additions to documentation label Mar 9, 2021
@DurgNomis-drol
Copy link
Collaborator

@KapJI I will take this (so i can learn how to use poetry). 😄 But i will probably first be able to look at it in the weekend, hope that is okay

@KapJI
Copy link
Collaborator Author

KapJI commented Mar 10, 2021

Sure, thank you! Poetry is pretty simple, just run poetry install and it will configure everything for you.

@DurgNomis-drol DurgNomis-drol linked a pull request Mar 11, 2021 that will close this issue
Closes #78 #89
Merged
@KapJI KapJI closed this as completed in #89 Mar 11, 2021
KapJI added a commit that referenced this issue Mar 11, 2021
@DurgNomis-drol @KapJI
Closes #78 (#89)
a644730 
* Added missing docstrings

* Fixed pre-commit

* Fixed pre-commit 2

* Update custom_components/google_home/api.py

Co-authored-by: Ruslan Sayfutdinov <ruslan@sayfutdinov.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Closes #78 DurgNomis-drol/ha-google-home
3 participants
@KapJI @leikoilja @DurgNomis-drol