Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
please clarify documentation on service watch #40819
The document at https://docs.saltstack.com/en/latest/ref/states/all/salt.states.service.html is too confusing for its own good when it comes to the watching. The description at salt.states.service.mod_watch doesn't go into any nuance, it just says:
If the user looks that up, they will miss some of the nuance from the general section:
This sentence should be moved or copied under mod_watch.
Also, the term "by default" is repeated twice in the same sentence, so one of those should be removed.
Furthermore, the descriptions of options are problematic:
Please rephrase the part in parenthesis, it sounds like it's trying to map boolean logic into simple English, but it's not actually succeeding, since the phrase "Y = Exclusive option with X" is a bad translation of XOR - just say "Y cannot be combined with X". Pseudo-code would have been more readable than this :)
Ditto for the parenthesized part.
In context of a state named "service", the reference to "service.full_restart", which I assume is to the module named "service", is unclear. Especially when one can't actually find that at https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.service.html
Also, somewhere in there it wouldn't hurt to explain briefly what is meant by "full" restart - someone might think it's service(8)'s
Please fix this. TIA.
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.
If this issue is closed prematurely, please leave a comment and we will gladly reopen the issue.