christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-12 14:17:46 +00:00
Code Issues Releases Activity

docs: fix ENV_PATCHES example

Browse Source
This commit is contained in:
Régis Behmo 2023-05-16 12:03:38 +02:00
parent 2e276cbb09
commit f042ca9b90
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/tutorials/plugin.rst
View File

@ -71,8 +71,10 @@ This imports the ``hooks`` module from Tutor, which grants us access to ``hooks.
:: ::
hooks.Filters.ENV_PATCHES.add_item( hooks.Filters.ENV_PATCHES.add_item(
<name>, (
<content> <name>,
<content>
)
) )
This means "add ``<content>`` to the ``{{ patch("<name>") }}`` statement, thanks to the :py:data:`tutor.hooks.Filters.ENV_PATCHES` filter". In our case, we want to modify the LMS settings, both in production and development. The right patch for that is :patch:`openedx-lms-common-settings`. We add one item, which is a single Python-formatted line of code:: This means "add ``<content>`` to the ``{{ patch("<name>") }}`` statement, thanks to the :py:data:`tutor.hooks.Filters.ENV_PATCHES` filter". In our case, we want to modify the LMS settings, both in production and development. The right patch for that is :patch:`openedx-lms-common-settings`. We add one item, which is a single Python-formatted line of code::