@@ -22,8 +22,10 @@ class FilepathCodec(Codec):
2222
2323 This codec gives users maximum freedom in organizing their files while
2424 reusing DataJoint's store configuration. Files can be placed anywhere
25- in the store EXCEPT the reserved ``_hash/`` and ``_schema/`` sections
26- which are managed by DataJoint.
25+ in the store EXCEPT the reserved sections managed by DataJoint (the
26+ hash-addressed and schema-addressed sections — from each store's
27+ ``hash_prefix`` and ``schema_prefix`` settings, defaults ``_hash`` and
28+ ``_schema``).
2729
2830 This is useful when:
2931 - Files are managed externally (e.g., by acquisition software)
@@ -54,7 +56,8 @@ class Recordings(dj.Manual):
5456 JSON metadata: ``{path, store, size, timestamp}``
5557
5658 Reserved Sections:
57- Paths cannot start with ``_hash/`` or ``_schema/`` - these are managed by DataJoint.
59+ Paths cannot start with the store's reserved ``hash_prefix`` or
60+ ``schema_prefix`` sections (defaults ``_hash/`` and ``_schema/``).
5861
5962 Warning:
6063 The file must exist in the store at the specified path.
@@ -78,7 +81,8 @@ def encode(self, value: Any, *, key: dict | None = None, store_name: str | None
7881 Parameters
7982 ----------
8083 value : str
81- Relative path within the store. Cannot use reserved sections (_hash/, _schema/).
84+ Relative path within the store. Cannot use the store's reserved
85+ hash/schema sections.
8286 key : dict, optional
8387 Primary key values (unused).
8488 store_name : str, optional
@@ -92,7 +96,7 @@ def encode(self, value: Any, *, key: dict | None = None, store_name: str | None
9296 Raises
9397 ------
9498 ValueError
95- If path uses reserved sections (_hash/ or _schema/) .
99+ If path uses the store's reserved hash/schema sections .
96100 FileNotFoundError
97101 If file does not exist in the store.
98102 """
0 commit comments