Skip to content

Commit 9259345

Browse files
committed
Add missing API documentation
1 parent 1826750 commit 9259345

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/reference/api.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,18 @@ PATTERN_LIBRARY = {
117117
}
118118
```
119119

120+
## `monkey_utils`
121+
122+
### `override_tag`
123+
124+
This function tells the pattern library which Django tags to override, and optionally supports providing a default value. See [../guides/overriding-template-tags.md] for more information.
125+
126+
```python
127+
from pattern_library.monkey_utils import override_tag
128+
129+
override_tag(register, 'a_tag_name', default_html="https://example.com/")
130+
```
131+
120132
## Commands
121133

122134
### `render_patterns`
@@ -140,3 +152,5 @@ Usage:
140152
# View all options
141153
./manage.py render_patterns --help
142154
```
155+
156+
By default patterns will be saved in a `dpl-rendered-patterns` folder. Make sure to add this to your `.gitignore` and other ignore files, or customize the output directory with `--output`.

0 commit comments

Comments
 (0)