Skip to content

Update file header#21023

Merged
fabaff merged 9 commits into
devfrom
file-headers
Feb 13, 2019
Merged

Update file header#21023
fabaff merged 9 commits into
devfrom
file-headers

Conversation

@fabaff
Copy link
Copy Markdown
Member

@fabaff fabaff commented Feb 12, 2019

Description:

Update file header.

@fabaff fabaff requested review from a team, OttoWinter, OverloadUT and ludeeus as code owners February 12, 2019 23:38
@ghost ghost assigned fabaff Feb 12, 2019
@ghost ghost added the in progress label Feb 12, 2019
Comment thread homeassistant/components/asuswrt/__init__.py
@awarecan
Copy link
Copy Markdown
Contributor

Amazing, is that done by manual?

@awarecan
Copy link
Copy Markdown
Contributor

Will this fix the reverse link from document page to source code?

Support for esphome devices.

For more details about this component, please refer to the documentation at
https://home-assistant.io/components/esphome/
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add this?

@rohankapoorcom
Copy link
Copy Markdown
Member

@awarecan reverse links should have been fixed in home-assistant/home-assistant.io#8379 (once all platforms are in a component)

Copy link
Copy Markdown
Member

@rohankapoorcom rohankapoorcom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we removing the the docs links?

@fabaff
Copy link
Copy Markdown
Member Author

fabaff commented Feb 13, 2019

Why are we removing the the docs links?

Because over the last few weeks we integrated implementations where the links were missing and nobody was complaining. Also, more and more integrations make use of the config flow.

We added the links to have a reference to the documentation back when we didn't have the component overview at ha.io and all implementations required a manual configuration.

Will this fix the reverse link from document page to source code?

Unfortunately not.

@fabaff fabaff requested a review from bachya as a code owner February 13, 2019 09:30
@dgomes
Copy link
Copy Markdown
Contributor

dgomes commented Feb 13, 2019

I still find the need to get a better description of what each component is about. I would vote for keeping the link.

@fabaff fabaff requested review from scop and syssi as code owners February 13, 2019 11:20
Comment thread homeassistant/components/xiaomi_aqara/switch.py Outdated
Comment thread homeassistant/components/wirelesstag/switch.py Outdated
Comment thread homeassistant/components/smartthings/climate.py Outdated
Comment thread homeassistant/components/utility_meter/sensor.py Outdated
Comment thread homeassistant/components/upnp/__init__.py Outdated
Comment thread homeassistant/components/thinkingcleaner/switch.py Outdated
@fabaff
Copy link
Copy Markdown
Member Author

fabaff commented Feb 13, 2019

For the users it's very hard to get source files especially when they are not running HA in a venv. Thus it doesn't add much value.

@MartinHjelmare
Copy link
Copy Markdown
Member

I'm in favor of removing the url from the docstring. Removing it removes one thing from the checklist of things the contributors needs to get right. That's good.

@fabaff fabaff merged commit 127c55e into dev Feb 13, 2019
@ghost ghost removed the in progress label Feb 13, 2019
@delete-merged-branch delete-merged-branch Bot deleted the file-headers branch February 13, 2019 20:21
@balloob balloob mentioned this pull request Feb 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants