Browse Source

Remove versionadded / versionchanged annotations for 5.2

Matt Westcott 1 year ago
parent
commit
c1ad975b3b

+ 0 - 4
docs/advanced_topics/api/v2/usage.md

@@ -231,10 +231,6 @@ Content-Type: application/json
 }
 }
 ```
 ```
 
 
-```{versionadded} 5.2
-
-```
-
 #### Random ordering
 #### Random ordering
 
 
 Passing `random` into the `?order` parameter will make results return in a
 Passing `random` into the `?order` parameter will make results return in a

+ 0 - 8
docs/extending/admin_views.md

@@ -277,10 +277,6 @@ Compared to the previous example with the two separate hooks, this will result i
 
 
 For further customisations, refer to the {class}`~wagtail.admin.viewsets.base.ViewSet` documentation.
 For further customisations, refer to the {class}`~wagtail.admin.viewsets.base.ViewSet` documentation.
 
 
-```{versionadded} 5.2
-Support for registering a menu item in the base `ViewSet` class was added.
-```
-
 (using_base_viewsetgroup)=
 (using_base_viewsetgroup)=
 
 
 ## Combining multiple `ViewSet`s using a `ViewSetGroup`
 ## Combining multiple `ViewSet`s using a `ViewSetGroup`
@@ -312,7 +308,3 @@ def register_viewset():
 This will result in a top-level menu item "Agenda" with the two viewsets' menu items as sub-items, e.g. "Calendar" and "Events".
 This will result in a top-level menu item "Agenda" with the two viewsets' menu items as sub-items, e.g. "Calendar" and "Events".
 
 
 For further customisations, refer to the {class}`~wagtail.admin.viewsets.base.ViewSetGroup` documentation.
 For further customisations, refer to the {class}`~wagtail.admin.viewsets.base.ViewSetGroup` documentation.
-
-```{versionadded} 5.2
-The `ViewSetGroup` class was added.
-```

+ 0 - 4
docs/extending/generic_views.md

@@ -145,10 +145,6 @@ By default, the model registered with a `ModelViewSet` will also be registered t
 
 
 Various additional attributes are available to customise the viewset - see the {class}`ModelViewSet` documentation.
 Various additional attributes are available to customise the viewset - see the {class}`ModelViewSet` documentation.
 
 
-```{versionadded} 5.2
-The ability to customise the menu item, listing view, inspect view, templates, and reference indexing were added.
-```
-
 (chooserviewset)=
 (chooserviewset)=
 
 
 ## ChooserViewSet
 ## ChooserViewSet

+ 0 - 4
docs/reference/contrib/searchpromotions.md

@@ -60,10 +60,6 @@ To retrieve a list of promoted search results for a particular search query, you
 </ul>
 </ul>
 ```
 ```
 
 
-```{versionadded} 5.2
-    Support for `external_link_url` and `external_link_text` were added.
-```
-
 ### Managing stored search queries
 ### Managing stored search queries
 
 
 The `searchpromotions` module keeps a log of search queries as well as the number of daily hits through the `Query` and `QueryDailyHits` models.
 The `searchpromotions` module keeps a log of search queries as well as the number of daily hits through the `Query` and `QueryDailyHits` models.

+ 0 - 32
docs/reference/hooks.md

@@ -247,10 +247,6 @@ Add an item to the Wagtail admin menu. The callable passed to this hook must ret
 -   `classname` - additional classes applied to the link.
 -   `classname` - additional classes applied to the link.
 -   `order` - an integer which determines the item's position in the menu.
 -   `order` - an integer which determines the item's position in the menu.
 
 
-```{versionchanged} 5.2
-Use `classname` as the `classnames` keyword argument is deprecated and will be removed in a future release.
-```
-
 For menu items that are only available to superusers, the subclass `wagtail.admin.menu.AdminOnlyMenuItem` can be used in place of `MenuItem`.
 For menu items that are only available to superusers, the subclass `wagtail.admin.menu.AdminOnlyMenuItem` can be used in place of `MenuItem`.
 
 
 `MenuItem` can be further subclassed to customise its initialisation or conditionally show or hide the item for specific requests (for example, to apply permission checks); see the source code (`wagtail/admin/menu.py`) for details.
 `MenuItem` can be further subclassed to customise its initialisation or conditionally show or hide the item for specific requests (for example, to apply permission checks); see the source code (`wagtail/admin/menu.py`) for details.
@@ -370,10 +366,6 @@ Add an item to the Wagtail admin search "Other Searches". Behaviour of this hook
 -   `attrs` - additional HTML attributes to apply to the link.
 -   `attrs` - additional HTML attributes to apply to the link.
 -   `order` - an integer which determines the item's position in the list of options.
 -   `order` - an integer which determines the item's position in the list of options.
 
 
-```{versionchanged} 5.2
-Use `classname` as the `classnames` keyword argument is deprecated and will be removed in a future release.
-```
-
 Setting the URL can be achieved using reverse() on the target search page. The GET parameter 'q' will be appended to the given URL.
 Setting the URL can be achieved using reverse() on the target search page. The GET parameter 'q' will be appended to the given URL.
 
 
 A template tag, `search_other` is provided by the `wagtailadmin_tags` template module. This tag takes a single, optional parameter, `current`, which allows you to specify the `name` of the search option currently active. If the parameter is not given, the hook defaults to a reverse lookup of the page's URL for comparison against the `url` parameter.
 A template tag, `search_other` is provided by the `wagtailadmin_tags` template module. This tag takes a single, optional parameter, `current`, which allows you to specify the `name` of the search option currently active. If the parameter is not given, the hook defaults to a reverse lookup of the page's URL for comparison against the `url` parameter.
@@ -568,10 +560,6 @@ The arguments passed to the hook are as follows:
 
 
 The `priority` argument controls the order the buttons are displayed in the dropdown. Buttons are ordered from low to high priority, so a button with `priority=10` will be displayed before a button with `priority=60`.
 The `priority` argument controls the order the buttons are displayed in the dropdown. Buttons are ordered from low to high priority, so a button with `priority=10` will be displayed before a button with `priority=60`.
 
 
-```{versionchanged} 5.2
-The hook function now receives a `user` argument instead of a `page_perms` argument, and a `view_name` argument. To check the user's permissions on the page, use `page.permissions_for_user(user)`.
-```
-
 ## Editor workflow
 ## Editor workflow
 
 
 Hooks for customising the way users are directed through the process of creating page content.
 Hooks for customising the way users are directed through the process of creating page content.
@@ -1026,10 +1014,6 @@ The arguments passed to the hook are as follows:
 
 
 The `priority` argument controls the order the buttons are displayed in. Buttons are ordered from low to high priority, so a button with `priority=10` will be displayed before a button with `priority=20`.
 The `priority` argument controls the order the buttons are displayed in. Buttons are ordered from low to high priority, so a button with `priority=10` will be displayed before a button with `priority=20`.
 
 
-```{versionchanged} 5.2
-The hook function now receives a `user` argument instead of a `page_perms` argument. To check the user's permissions on the page, use `page.permissions_for_user(user)`.
-```
-
 (register_page_listing_more_buttons)=
 (register_page_listing_more_buttons)=
 
 
 ### `register_page_listing_more_buttons`
 ### `register_page_listing_more_buttons`
@@ -1058,10 +1042,6 @@ The arguments passed to the hook are as follows:
 
 
 The `priority` argument controls the order the buttons are displayed in the dropdown. Buttons are ordered from low to high priority, so a button with `priority=10` will be displayed before a button with `priority=60`.
 The `priority` argument controls the order the buttons are displayed in the dropdown. Buttons are ordered from low to high priority, so a button with `priority=10` will be displayed before a button with `priority=60`.
 
 
-```{versionchanged} 5.2
-The hook function now receives a `user` argument instead of a `page_perms` argument. To check the user's permissions on the page, use `page.permissions_for_user(user)`.
-```
-
 #### Buttons with dropdown lists
 #### Buttons with dropdown lists
 
 
 The admin widgets also provide `ButtonWithDropdownFromHook`, which allows you to define a custom hook for generating a dropdown menu that gets attached to your button.
 The admin widgets also provide `ButtonWithDropdownFromHook`, which allows you to define a custom hook for generating a dropdown menu that gets attached to your button.
@@ -1098,10 +1078,6 @@ def page_custom_listing_more_buttons(page, user, next_url=None):
 
 
 The template for the dropdown button can be customised by overriding `wagtailadmin/pages/listing/_button_with_dropdown.html`. Make sure to leave the dropdown UI component itself as-is.
 The template for the dropdown button can be customised by overriding `wagtailadmin/pages/listing/_button_with_dropdown.html`. Make sure to leave the dropdown UI component itself as-is.
 
 
-```{versionchanged} 5.2
-The `ButtonWithDropdownFromHook` constructor, and the corresponding hook function, now receive a `user` argument instead of a `page_perms` argument.
-```
-
 (construct_page_listing_buttons)=
 (construct_page_listing_buttons)=
 
 
 ### `construct_page_listing_buttons`
 ### `construct_page_listing_buttons`
@@ -1115,10 +1091,6 @@ def remove_page_listing_button_item(buttons, page, user, context=None):
         buttons.pop() # removes the last 'more' dropdown button on the root page listing buttons
         buttons.pop() # removes the last 'more' dropdown button on the root page listing buttons
 ```
 ```
 
 
-```{versionchanged} 5.2
-The hook function now receives a `user` argument instead of a `page_perms` argument. To check the user's permissions on the page, use `page.permissions_for_user(user)`.
-```
-
 ## Page serving
 ## Page serving
 
 
 (before_serve_page)=
 (before_serve_page)=
@@ -1342,10 +1314,6 @@ def remove_snippet_listing_button_item(buttons, snippet, user):
     buttons.pop()  # Removes the 'delete' button
     buttons.pop()  # Removes the 'delete' button
 ```
 ```
 
 
-```{versionchanged} 5.2
-The `context` argument has been removed from this hook.
-```
-
 ## Bulk actions
 ## Bulk actions
 
 
 Hooks for registering and customising bulk actions. See [](custom_bulk_actions) on how to write custom bulk actions.
 Hooks for registering and customising bulk actions. See [](custom_bulk_actions) on how to write custom bulk actions.

+ 0 - 4
docs/reference/management_commands.md

@@ -54,10 +54,6 @@ days will be deleted.
 
 
 To prevent deleting important revisions when they become stale, you can refer to such revisions in a model using a `ForeignKey` with {attr}`on_delete=models.PROTECT <django.db.models.PROTECT>`.
 To prevent deleting important revisions when they become stale, you can refer to such revisions in a model using a `ForeignKey` with {attr}`on_delete=models.PROTECT <django.db.models.PROTECT>`.
 
 
-```{versionadded} 5.2
-Support for respecting `on_delete=models.PROTECT` is added.
-```
-
 If the `pages` argument is supplied, only revisions of page models will be deleted. If the `non-pages` argument is supplied, only revisions of non-page models will be deleted. If both or neither arguments are supplied, revisions of all models will be deleted.
 If the `pages` argument is supplied, only revisions of page models will be deleted. If the `non-pages` argument is supplied, only revisions of non-page models will be deleted. If both or neither arguments are supplied, revisions of all models will be deleted.
 If deletion of a revision is not desirable, mark `Revision` with `on_delete=models.PROTECT`.
 If deletion of a revision is not desirable, mark `Revision` with `on_delete=models.PROTECT`.
 
 

+ 0 - 4
docs/reference/pages/panels.md

@@ -117,10 +117,6 @@ Here are some built-in panel types that you can use in your panel definitions. T
 
 
 You may want to execute some JavaScript when `InlinePanel` items are ready, added or removed. The `w-formset:ready`, `w-formset:added` and `w-formset:removed` events allow this.
 You may want to execute some JavaScript when `InlinePanel` items are ready, added or removed. The `w-formset:ready`, `w-formset:added` and `w-formset:removed` events allow this.
 
 
-```{versionadded} 5.2
-
-```
-
 For example, given a child model that provides a relationship between Blog and Person on `BlogPage`.
 For example, given a child model that provides a relationship between Blog and Person on `BlogPage`.
 
 
 ```python
 ```python