Skip to content

Commit 7702686

Browse files
committed
docs: add module level docstring to interlinks
1 parent f5fb12f commit 7702686

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

quartodoc/interlinks.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
"""The interlinks module fully specifies the behavior of an interlinks filter.
2+
3+
Note that this module largely exists for two reasons:
4+
5+
* Allow people to explore / debug interlinks in python.
6+
* Provide a reference implementation for the lua interlinks filter.
7+
8+
See quartodoc.tests.test_interlinks for its implementation, and the fully
9+
loaded specification.
10+
"""
11+
12+
113
from __future__ import annotations
214

315
import os

0 commit comments

Comments
 (0)