Skip to content

docs: normalize memory docstring cross-references#3370

Merged
seratch merged 1 commit into
mainfrom
docs/normalize-memory-docstring-autorefs
May 11, 2026
Merged

docs: normalize memory docstring cross-references#3370
seratch merged 1 commit into
mainfrom
docs/normalize-memory-docstring-autorefs

Conversation

@seratch
Copy link
Copy Markdown
Member

@seratch seratch commented May 11, 2026

This pull request updates the memory extension docstrings to use MkDocs/mkdocstrings-compatible Markdown autorefs instead of Sphinx-style roles that render literally in the generated API reference.

The change replaces invalid or ineffective :pyclass: / :class: references in the memory extension package with links such as [Session][agents.memory.session.Session], and leaves external PyMongo types as plain code spans. It affects only documentation text in docstrings and does not change runtime behavior or public APIs.

@github-actions github-actions Bot added documentation Improvements or additions to documentation feature:extensions labels May 11, 2026
@seratch seratch enabled auto-merge (squash) May 11, 2026 23:01
@seratch seratch merged commit ae3263b into main May 11, 2026
10 checks passed
@seratch seratch deleted the docs/normalize-memory-docstring-autorefs branch May 11, 2026 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation feature:extensions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant