saltstack / salt

Software to automate the management and configuration of any infrastructure or application at scale. Get access to the Salt software package repository here:
https://repo.saltproject.io/
Apache License 2.0
14.1k stars 5.47k forks source link

[DOCS] states.service.running example does not match the documentation #63852

Open joshmcorreia opened 1 year ago

joshmcorreia commented 1 year ago

Description At the top of the page there is the following example which indicates that there is a reload parameter:

redis:
  service.running:
    - enable: True
    - reload: True
    - watch:
      - pkg: redis

Further down the page in the salt.states.service.running(name, enable=None, sig=None, init_delay=None, **kwargs) section there is no mention of a reload parameter.

Suggested Fix Make the example match the documentation, or add the missing parameter onto the documentation, whichever is correct.

Type of documentation Salt documentation

Location or format of documentation

whytewolf commented 1 year ago

that isn't actually a mistake. but does need to be clearer.

reload isn't an argument of service.running. it is an argument of service.mod_watch. which is what gets triggered with the watch requisite.