Skip to content

Commit 962d885

Browse files
committed
improve docstring for IDOM_CLIENT_BUILD_DIR
1 parent 4fe70b6 commit 962d885

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/idom/config.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,12 @@
2424
default=Path(__file__).parent / "client" / "build",
2525
validator=Path,
2626
)
27-
"""The location IDOM will use to store its client application"""
27+
"""The location IDOM will use to store its client application
28+
29+
This directory **MUST** be treated as a black box. Downstream applications **MUST NOT**
30+
assume anything about the structure of this directory see :mod:`idom.client.manage` for
31+
a set of publically available APIs for working with the client.
32+
"""
2833

2934
IDOM_CLIENT_WEB_MODULE_BASE_URL = _option.Option(
3035
"IDOM_CLIENT_WEB_MODULE_BASE_URL",

0 commit comments

Comments
 (0)