Open
Description
Is your feature request related to a problem? Please describe.
I need to offer the ability to click on a type and go to the documentation for that type. Also, I would like the default compact signatures with syntax highlighting.
Describe the solution you'd like
Support for enabling signature_crossrefs
without enabling separate_signature
.
Describe alternatives you've considered
- Enabling
separate_signature
everywhere - Enabling
separate_signature
only for signatures that actually have types defined by local code rather than the built-in types likelist
, which leads to inconsistent formatting like in this screenshot
Additional context
I understand based on your assessment in #65 (comment) that this approach is not without trade-offs but I think would be beneficial to users nonetheless even if you imposed certain limitations.
Metadata
Metadata
Assignees
Type
Projects
Milestone
Relationships
Development
No branches or pull requests
Activity
pawamoy commentedon Apr 9, 2025
Hey @ofek, thanks for the feature request!
I don't think the comment you mention is relevant to this, as it was more generally about cross-refs in code blocks, while here we want cross-refs in inline code. I don't see anything preventing us from adding support for cross-refs in inline signatures (though I might be forgetting something), however note that there won't be any syntax highlighting or formatting 🙂 Other docs generators output their own set of spans and CSS classes to bring colors, which we won't do as part of this feature (but this can be requested later).