fan2go icon indicating copy to clipboard operation
fan2go copied to clipboard

Issues in Documentation

Open DanielGibson opened this issue 7 months ago • 5 comments

Based on https://github.com/markusressel/fan2go/pull/373#issuecomment-2918033447

See the list of sub-issues associated.

DanielGibson avatar May 31 '25 19:05 DanielGibson

Not sure how to respond to these all, as some of these deserve their own issue, others are fixed in a one liner PR. Also, not all of these are about the documentation, but rather require changes in the config, core logic or both. Lets separate these points some more until we can at least tell the documentation issues from the others.

markusressel avatar May 31 '25 22:05 markusressel

They're almost all about documentation?

HwMonController has both Name and Platform, fan2go detect prints the Name, but in the config the "platform" is supposed to be used

is more about documentation in the code (add comments to make clear what Platform and Name in the HwMonController mean), but that's still documentation - and probably only a few lines of comments, nothing big.

Ok, the point about using percent or raw PWM is not exactly documentation, but directly related to its parent-point which is about misleading documentation. I could create an issue about that - does it need a completely new issue, or is there already one that's close enough to the topic?

DanielGibson avatar May 31 '25 22:05 DanielGibson

(My idea was: Fix as many of these issues with small changes as possible, and create proper (sub)issues only for the bigger topics that are left in the end, or that may even turn up when figuring out the exact behavior. Github even supports turning a checkmark into a full issue or sub-issue by clicking those three dots next to the line)

DanielGibson avatar May 31 '25 22:05 DanielGibson

I haven't really worked with sub issues yet but we can give it a try 👍

markusressel avatar May 31 '25 23:05 markusressel

I fixed the most simple issues (where I knew what to write without reading much source) in a commit in #373. I ticked those off above.

DanielGibson avatar Jun 01 '25 04:06 DanielGibson