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] dry_run in docstring of file.blockreplace state, but not implemented #60227

Closed
Timmeeh opened this issue May 21, 2021 · 1 comment · Fixed by #61916
Closed

[DOCS] dry_run in docstring of file.blockreplace state, but not implemented #60227

Timmeeh opened this issue May 21, 2021 · 1 comment · Fixed by #61916
Labels
docstring-update string edits Documentation Relates to Salt documentation good first issue good for someone new to salt help-wanted Community help is needed to resolve this severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-single-day
Milestone

Comments

@Timmeeh
Copy link

Timmeeh commented May 21, 2021

Description
dry_run kwarg is documented in docstring of file.blockreplace state, but not implemented

Suggested Fix
Remove dry_run from the docstring

Type of documentation
Salt Repo

Location or format of documentation
https://github.com/saltstack/salt/blob/v3003/salt/states/file.py#L5614
https://docs.saltproject.io/en/3003/ref/states/all/salt.states.file.html#salt.states.file.blockreplace

Additional context
blockreplace seems to be the only function in the file module that still has this kwarg documented.

@Timmeeh Timmeeh added Documentation Relates to Salt documentation needs-triage labels May 21, 2021
@welcome
Copy link

welcome bot commented May 21, 2021

Hi there! Welcome to the Salt Community! Thank you for making your first contribution. We have a lengthy process for issues and PRs. Someone from the Core Team will follow up as soon as possible. In the meantime, here’s some information that may help as you continue your Salt journey.
Please be sure to review our Code of Conduct. Also, check out some of our community resources including:

There are lots of ways to get involved in our community. Every month, there are around a dozen opportunities to meet with other contributors and the Salt Core team and collaborate in real time. The best way to keep track is by subscribing to the Salt Community Events Calendar.
If you have additional questions, email us at saltproject@vmware.com. We’re glad you’ve joined our community and look forward to doing awesome things with you!

@sagetherage sagetherage added docstring-update string edits severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around and removed needs-triage labels May 21, 2021
@sagetherage sagetherage added this to the Approved milestone May 21, 2021
@barbaricyawps barbaricyawps added time-estimate-single-day good first issue good for someone new to salt help-wanted Community help is needed to resolve this labels Feb 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docstring-update string edits Documentation Relates to Salt documentation good first issue good for someone new to salt help-wanted Community help is needed to resolve this severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around time-estimate-single-day
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants