Skip to content

Clean up docstrings#22679

Merged
pvizeli merged 5 commits intohome-assistant:devfrom
cgtobi:docstring_cleanup
Apr 3, 2019
Merged

Clean up docstrings#22679
pvizeli merged 5 commits intohome-assistant:devfrom
cgtobi:docstring_cleanup

Conversation

@cgtobi
Copy link
Copy Markdown
Contributor

@cgtobi cgtobi commented Apr 3, 2019

Breaking Change:

Description:

Just some cleanup of component docstrings.

Related issue (if applicable): fixes #

Pull request in home-assistant.io with documentation (if applicable): home-assistant/home-assistant.io#<home-assistant.io PR number goes here>

Example entry for configuration.yaml (if applicable):

Checklist:

  • The code change is tested and works locally.
  • Local tests pass with tox. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • New dependencies have been added to the REQUIREMENTS variable (example).
  • New dependencies are only imported inside functions that use them (example).
  • New or updated dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
  • New files were added to .coveragerc.

If the code does not interact with devices:

  • Tests have been added to verify that the new code works.

@ghost ghost assigned cgtobi Apr 3, 2019
@ghost ghost added the in progress label Apr 3, 2019
@robbiet480
Copy link
Copy Markdown
Contributor

Good to merge as soon as tests pass!

@cgtobi cgtobi requested a review from a team as a code owner April 3, 2019 08:56
@cgtobi cgtobi changed the title Clean up docstrings Clean up docstrings - DO NOT MERGE Apr 3, 2019
@cgtobi cgtobi changed the title Clean up docstrings - DO NOT MERGE WIP Clean up docstrings Apr 3, 2019
@cgtobi cgtobi changed the title WIP Clean up docstrings Clean up docstrings Apr 3, 2019
@cgtobi
Copy link
Copy Markdown
Contributor Author

cgtobi commented Apr 3, 2019

This has gotten way too big already. So I’ll stop here.

@pvizeli pvizeli merged commit 048b100 into home-assistant:dev Apr 3, 2019
@ghost ghost removed the in progress label Apr 3, 2019
@cgtobi cgtobi deleted the docstring_cleanup branch April 3, 2019 18:50
@AZDane
Copy link
Copy Markdown
Contributor

AZDane commented Apr 7, 2019

I have a question for you guys thats related to this commit. I put in a pull request 22411 12 days ago and its been sitting without review.
#22411
I see now that one of the files has been changed 4 days ago in this PR. How do I proceed from here? Do I start over or just make a new commit reflecting the changes in this commit plus mine? Initially it passed all tests, but now I see there are some ci/circleci tests waiting.
Yes I've been living under a rock and am new to the Github process :)
Also, is it likely my request will get a review? With 0.91 my custom_component that has the new changes no longer works, so I'm trying to decide between renaming my component and just use that or hope that the PR will be reviewed.
If at least one of you guys who is a known entity could put in a PR to fix the small error in concord232/binary_sensor.py. Its throwing a lot of errors at startup.
Thanks guys!!

@awarecan
Copy link
Copy Markdown
Contributor

awarecan commented Apr 7, 2019

Please do not comment in merged pull request. I left comment in your pull request.

When reviewer decide which pull request they will look into, they will consider (in this order)

  • if CLA signed
  • if small-pr labeled
  • if CI checks passed
  • if it is a bug fix

@home-assistant home-assistant locked as resolved and limited conversation to collaborators Apr 7, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants