added doc comments to attr_formatter and block_formatter

This commit is contained in:
truePhilipp committed 2024-05-07 13:23:17 +00:00
1 parent 936b752c3b
commit 5fc200a75b
2 files changed
+29 -2

No files matched your search

@@ -1,3 +1,15 @@
"""
block_formatter.py
This module contains a function `format` that modifies a BeautifulSoup object in place.
The function searches for all elements with the attribute "dj-block". The value of "dj-block" is expected to be a
string representing the name of a Django block. For each found element, it inserts Django block tags before and after
the element, using the value of "dj-block" as the block name. Then it removes the "dj-block" attribute from the element.
Example:
If an element is <div dj-block="content">Content</div>,
after processing, it becomes {% block content %}Content{% endblock %}.
"""
from bs4 import BeautifulSoup