Skip to content

docs(checkpoint,checkpoint-postgres): clarify Store value and namespace semantics#8001

Open
Mason Daugherty (mdrxy) wants to merge 1 commit into
mainfrom
mdrxy/store-docstring-pass
Open

docs(checkpoint,checkpoint-postgres): clarify Store value and namespace semantics#8001
Mason Daugherty (mdrxy) wants to merge 1 commit into
mainfrom
mdrxy/store-docstring-pass

Conversation

@mdrxy

Copy link
Copy Markdown
Member

Resolves a customer escalation (DOC-1115) where the put/aput/alist_namespaces semantics for AsyncPostgresStore weren't documented anywhere reachable from its reference page. Two confusions drove it: the empty value/None and case-sensitivity behavior was never written down, and AsyncBatchedBaseStore shadowed BaseStore's documented methods with empty docstrings.

@open-swe open-swe Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Open SWE Review found 1 potential issue.

View Open SWE trace

Comment on lines +963 to +966
prefix: Filter namespaces that start with this path. Matched exactly and
case-sensitively.
suffix: Filter namespaces that end with this path. Matched exactly and
case-sensitively.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Docs hide namespace wildcard matching

This newly added text says prefix/suffix are matched “exactly”, but NamespacePath explicitly allows * and both the in-memory matcher and Postgres query builder treat * as a wildcard for one namespace segment. Users reading this reference page would be told that wildcard namespace filters are not supported/exact-only even though list_namespaces(prefix=("users", "*")) is valid behavior. The same wording is repeated in alist_namespaces and the Postgres store notes, so those copies should be updated consistently to say matching is case-sensitive while preserving the documented * wildcard semantics.

(Refers to lines 963-966)


Was this helpful? React with 👍 or 👎 to provide feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant