[DOCS] salt.states.timezone has conflicting information about the default value of `utc`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
https://docs.saltproject.io/en/master/ref/states/all/salt.states.timezone.html says both of the below things:
By default, the hardware clock is set to localtime, meaning it is set to the same time as the system clock. If utc is set to True, then the hardware clock will be set to UTC, and the system clock will be an offset of that.
utc
Whether or not to set the hardware clock to UTC (default is True)
Suggested Fix
If those two actually conflict, I'd assume one should be changed, but I don't know which one. If they don't actually conflict, then some additional explanation might be nice. (I'm pretty tired right now though, so it's also possible I'm just missing something obvious.)
Type of documentation
Salt state documentation.
Location or format of documentation
https://docs.saltproject.io/en/master/ref/states/all/salt.states.timezone.html
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the salt.states.timezone documentation at the linked page and compare the explanatory text with the utc parameter description. Verify which default is correct, then revise the conflicting wording or add clarification so the page states one unambiguous behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100