Skip to content

Commit

Permalink
docs: update guidelines according latest changes
Browse files Browse the repository at this point in the history
  • Loading branch information
mariajgrimaldi committed Jan 13, 2025
1 parent 55f7237 commit 20a851c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/reference/documenting-filters-classes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ The docstring should comply with the following guidelines:

- The docstring should be a triple-quoted string.
- The docstring should be placed at the beginning of the class definition.
- The docstring should describe the purpose of the filter.
- The docstring should include a brief description of what's supposed to do.
- The docstring should describe the purpose of the filter.
- The docstring should include the filter type ``filter_type``, which is the unique identifier for the filter.
- The docstring should include the trigger information, which includes the repository, path, and function or method that triggers the filter.
- The docstring should include any other relevant information about the filter (e.g., it works only for legacy views not MFEs).
Expand All @@ -19,9 +19,9 @@ Consider the following example:
class AccountSettingsRenderStarted(OpenEdxPublicFilter):
"""
Description:
Filter used to modify the rendering of the account settings page in the LMS.
Filter used to modify the rendering of the account settings page in the LMS.
Purpose:
This filter is triggered when a user visits the account settings page, just before the page is rendered allowing
the filter to modify the context and the template used to render the page.
Expand Down

0 comments on commit 20a851c

Please sign in to comment.