Update docs remove dry_run in docstring of file.blockreplace state.

This commit is contained in:
Eric Ham 2022-04-04 23:07:15 -07:00 committed by Megan Wilhite
parent eab3640f21
commit 286c907eae
3 changed files with 1 additions and 8 deletions

1
changelog/60227.fixed Normal file
View file

@ -0,0 +1 @@
Update docs remove dry_run in docstring of file.blockreplace state.

View file

@ -403425,10 +403425,6 @@ New in version 3001.
The file extension to use for a backup of the file if any edit is made.
Set this to \fBFalse\fP to skip making a backup.
.TP
.B dry_run
If \fBTrue\fP, do not make any edits to the file and simply return the
changes that \fIwould\fP be made.
.TP
.B show_changes
Controls how changes are presented. If \fBTrue\fP, the \fBChanges\fP
section of the state return will contain a unified diff of the changes

View file

@ -5889,10 +5889,6 @@ def blockreplace(
The file extension to use for a backup of the file if any edit is made.
Set this to ``False`` to skip making a backup.
dry_run
If ``True``, do not make any edits to the file and simply return the
changes that *would* be made.
show_changes
Controls how changes are presented. If ``True``, the ``Changes``
section of the state return will contain a unified diff of the changes