mirrors/wagtail
mirrors/wagtail
0
0
Fork 0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-28 08:48:04 +01:00
Code Issues Releases Wiki Activity

Update documentation for log_action parameter on RevisionMixin.save_revision

Browse Source 
Previous documentation seemed to incorrectly imply that
the default value for `log_action` was `True` when it is
in fact `False`. This can confuse readers not looking at
the method signature.
This commit is contained in:
Christer Jensen 2023-05-17 00:00:49 +02:00 committed by Sage Abdullah
parent 351bffa304
commit 2189652ae9
No known key found for this signature in database
GPG Key ID: EB1A33CC51CC0217
6 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CONTRIBUTORS.rst
View File

@ -709,6 +709,7 @@ Contributors
* Swojak-A
* fidoriel
* Ramon Wenger
* Christer Jensen
Translators
===========

4
docs/releases/4.1.6.md
View File

@ -15,3 +15,7 @@ depth: 1
* Rectify previous fix for TableBlock becoming uneditable after save (Sage Abdullah)
* Ensure that copying page correctly picks up the latest revision (Matt Westcott)
### Documentation
* Update documentation for `log_action` parameter on `RevisionMixin.save_revision` (Christer Jensen)

4
docs/releases/4.2.4.md
View File

@ -15,3 +15,7 @@ depth: 1
* Rectify previous fix for TableBlock becoming uneditable after save (Sage Abdullah)
* Ensure that copying page correctly picks up the latest revision (Matt Westcott)
### Documentation
* Update documentation for `log_action` parameter on `RevisionMixin.save_revision` (Christer Jensen)

4
docs/releases/5.0.1.md
View File

@ -15,3 +15,7 @@ depth: 1
* Rectify previous fix for TableBlock becoming uneditable after save (Sage Abdullah)
* Ensure that copying page correctly picks up the latest revision (Matt Westcott)
### Documentation
* Update documentation for `log_action` parameter on `RevisionMixin.save_revision` (Christer Jensen)

1
docs/releases/5.1.md
View File

@ -29,6 +29,7 @@ FieldPanels can now be marked as read-only with the `read_only=True` keyword arg
* Document how to add non-ModelAdmin views to a `ModelAdminGroup` (Onno Timmerman)
* Document how to add StructBlock data to a StreamField (Ramon Wenger)
* Update ReadTheDocs settings to v2 to resolve urllib3 issue in linkcheck extension (Thibaud Colas)
* Update documentation for `log_action` parameter on `RevisionMixin.save_revision` (Christer Jensen)
### Maintenance

2
wagtail/models/__init__.py
View File

@ -349,7 +349,7 @@ class RevisionMixin(models.Model):
:param submitted_for_moderation: Indicates whether the object was submitted for moderation.
:param approved_go_live_at: The date and time the revision is approved to go live.
:param changed: Indicates whether there were any content changes.
:param log_action: Flag for logging the action. Pass ``False`` to skip logging. Can be passed an action string.
:param log_action: Flag for logging the action. Pass ``True`` to also create a log entry. Can be passed an action string.
Defaults to ``"wagtail.edit"`` when no ``previous_revision`` param is passed, otherwise ``"wagtail.revert"``.
:param previous_revision: Indicates a revision reversal. Should be set to the previous revision instance.
:type previous_revision: Revision