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

docs: improve param documentation #98

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Myriad-Dreamin
Copy link

No description provided.

@OrangeX4
Copy link
Member

How to make tinymist to support #example()? Syntax like

/// #example(`
/// #alternatives-match((
///   "1, 3-5": [this text has the majority],
///   "2, 6": [this is shown less often]
/// ))
/// `)

will make docs disappear.

@OrangeX4
Copy link
Member

Now I'm using

/// Example: `#something()`

@Myriad-Dreamin
Copy link
Author

We can completely follow format of tidy docs rather than workaround bugs, as we'll finally fix them. And, we can add more features if there should be missing ones.

@Myriad-Dreamin Myriad-Dreamin marked this pull request as ready for review November 17, 2024 03:00
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.

2 participants