Latest Results
ENG-9533 feat: render concise, readable types in docgen class documentation (#6634)
* feat: render concise, readable types in docgen class documentation
Rework reflex-docgen's type/signature rendering so generated class docs
read cleanly instead of leaking implementation noise.
- Add a public format_type() that strips module qualifiers, preserves
type-alias names, and renders unions (Optional[...]), literals, and
callables recursively.
- Define the ASGI aliases (Scope, Message, Receive, Send, ASGIApp) via
TypeAliasType so their short names survive introspection and docs show
e.g. ASGIApp rather than a fully expanded MutableMapping/Awaitable blob.
- Render method signatures without self/cls, with forward-ref strings kept
verbatim (each annotation independently, so one TYPE_CHECKING-only name
doesn't poison the rest) and optionality normalized to match format_type.
- Clean field/parameter defaults: show function names or empty-collection
literals instead of volatile <function ... at 0x...> reprs, and exclude
function-valued field defaults from the methods table.
- Polish App attribute docstrings with doc links and a fuller
api_transformer description.
* refactor: inline single-use docgen type-formatting helpers
Fold _literal_value, _EMPTY_FACTORY_DISPLAY, _strip_module_qualifiers, and
_optional_from_string into their lone call sites. The string-only forward-ref
handling now lives directly in _format_annotation, so the qualifier-stripping
and Optional[...] rewrite read top-to-bottom in one place instead of hopping
through tiny indirections. No behavior change; tests updated to exercise
_format_annotation directly.
* fix: stop docgen duplicating Attributes as both prose and fields table
The class description was the raw cleandoc'd docstring, so a Google-style
Attributes section rendered both as body text and in the fields table,
duplicating every attribute on the API reference page. Parse the docstring
into griffe sections once and derive the prose description (sans Attributes)
and the attribute mapping from the same result.
Also drop the deprecated rx.Model from the generated API reference.
---------
Co-authored-by: Masen Furer <m_github@0x26.net> Latest Branches
0%
masenf/sync-package-json-on-install 0%
0%
picklelo/fix-match-condition-usecontext © 2026 CodSpeed Technology