Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to reference symbols from within a block of code #3571

Open
qwwdfsad opened this issue Apr 19, 2024 · 0 comments
Open

Ability to reference symbols from within a block of code #3571

qwwdfsad opened this issue Apr 19, 2024 · 0 comments
Labels
enhancement An issue for a feature or an overall improvement kdoc-spec An issue that requires clarification from the KDoc spec's perspective

Comments

@qwwdfsad
Copy link
Member

Is your feature request related to a problem? Please describe

We have documentation where we want to explain that the entity lies in an open interval defined by the corresponding constants.
We want to both express it in a Kotlin-friendly way and make them referenceable and lined.

We have two options (I use ' as a backtick, otherwise GH render breaks):

  1. "Foo is within 'DISTANT_PAST..DISTANT_FUTURE'". Renders as a range, but constants are not linked at all
  2. "Foo is within [DISTANT_PAST]..[DISTANT_FUTURE]". Renders as two links and a weird separator between them.

Describe the solution you'd like

It would be nice to find a solution that both renders as a code and provides the corresponding link targets.
I have no specific suggestions ATM

@qwwdfsad qwwdfsad added enhancement An issue for a feature or an overall improvement kdoc-spec An issue that requires clarification from the KDoc spec's perspective labels Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An issue for a feature or an overall improvement kdoc-spec An issue that requires clarification from the KDoc spec's perspective
Projects
None yet
Development

No branches or pull requests

1 participant