esphome / issues

Issue Tracker for ESPHome
https://esphome.io/
290 stars 36 forks source link

Doc issue: LEDC documentation may refer to the wrong board #3346

Open Joshfindit opened 2 years ago

Joshfindit commented 2 years ago

The problem

The documentation here states

The ESP8266 for instance has usually a frequency of 1000Hz with a resolution of 10 bits. This means that there are only 4 steps between each value.

This is directly below the chart for the bit-depth to frequency relationship of the ESP32 (specifically the boards with LEDC).

Which version of ESPHome has the issue?

current

What type of installation are you using?

Docker

Which version of Home Assistant has the issue?

current

What platform are you using?

ESP32

Board

ESP32-Mini

Component causing the issue

No response

Example YAML snippet

No response

Anything in the logs that might be useful for us?

No response

Additional information

No response

probot-esphome[bot] commented 2 years ago

Hey there @ottowinter, mind taking a look at this issue as it has been labeled with an integration (ledc) you are listed as a code owner for? Thanks! (message by CodeOwnersMention)

github-actions[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Joshfindit commented 2 years ago

Still an issue: documentation still has the same wording

ssieb commented 2 years ago

This should be filed in the docs repo instead. Can you make a PR to fix it?

Joshfindit commented 2 years ago

@ssieb I can do the PR for sure as long as someone confirms that it should reference the ESP32 instead

ssieb commented 2 years ago

I'm not sure what the intent of that line was. It might just be a comparison of how an ESP8266 compares to using ledc on an ESP32. It's not misleading or anything, just maybe confusing.