Skip to content

fix(docs): add returns_named_value property to handle description leaks - #95

Merged
OutSquareCapital merged 1 commit into
OutSquareCapital:masterfrom
tecnolgd:fix/return-docstrings
Sep 1, 2026
Merged

OutSquareCapital merged 1 commit into
OutSquareCapital:masterfrom
tecnolgd:fix/return-docstrings

Conversation

@tecnolgd

@tecnolgd tecnolgd commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

What's Changed

  • Fixed description leaks in return types involving generics.
  • Converts the Returns table format to a 2-column layout (Type | Description).

Checklist

Tested the build and verified the site locally.

  • uv run zensical build -c
  • uv run zensical serve

Fixes #9

@OutSquareCapital

OutSquareCapital commented Sep 1, 2026

Copy link
Copy Markdown
Owner

I'll just recheck on my end if I find again the reason as to why I wasn't willing to go that way last time I checked this param, if I can't recall why LGTM

Thank you for the help on this project, as always. Much appreciated

@tecnolgd

tecnolgd commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

Sounds good! Take your time checking it out. Let me know if anything comes up and I'll be happy to work on the other options.

@OutSquareCapital

Copy link
Copy Markdown
Owner

Okay, I kinda remember that it was an problem with the rendering of generic types, but I guess it's been since resolved by zensical, because testing it myself locally I didn't see any problem, and it fixed everything, so let's go with your proposal! thanks again :)

@OutSquareCapital
OutSquareCapital merged commit d557960 into OutSquareCapital:master Sep 1, 2026
13 checks passed
@tecnolgd
tecnolgd deleted the fix/return-docstrings branch September 2, 2026 02:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Returns types in documentation

2 participants