Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
joshmcorreia opened this issue Mar 9, 2023 · 1 comment
Open
Labels
Documentation Relates to Salt documentation severity-low 4th level, cosemtic problems, work around exists time-estimate-single-day

Comments

@joshmcorreia
Copy link
Contributor

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

@joshmcorreia joshmcorreia added Documentation Relates to Salt documentation needs-triage labels Mar 9, 2023
@whytewolf
Copy link
Contributor

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.

@barbaricyawps barbaricyawps added severity-low 4th level, cosemtic problems, work around exists time-estimate-single-day and removed needs-triage labels Mar 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Relates to Salt documentation severity-low 4th level, cosemtic problems, work around exists time-estimate-single-day
Projects
None yet
Development

No branches or pull requests

3 participants