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(toml): complete documentation #4223

Merged
merged 2 commits into from Jan 20, 2024
Merged

docs(toml): complete documentation #4223

merged 2 commits into from Jan 20, 2024

Conversation

sylc
Copy link
Contributor

@sylc sylc commented Jan 19, 2024

towards #3764

@sylc sylc requested a review from kt3k as a code owner January 19, 2024 13:41
@github-actions github-actions bot added the toml label Jan 19, 2024
@sylc
Copy link
Contributor Author

sylc commented Jan 19, 2024

The toml/mod module comment has an @example. But i'm not sure how useful that is from within intellisense. Should the example be duplicated on the 2 functions parse and stringify themselves ?
(also the main module comment uses markdown. is that ok?)

@kt3k
Copy link
Member

kt3k commented Jan 20, 2024

Should the example be duplicated on the 2 functions parse and stringify themselves ?

Duplicated example for parse and stringify functions are also useful in my view. Such examples will appear in html doc pages like this one https://deno.land/std@0.212.0/toml/mod.ts?s=parse

also the main module comment uses markdown. is that ok?

Markdown comments are fine. They are rendered nicely in html doc pages like this page.

Copy link
Member

@kt3k kt3k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks!

@kt3k kt3k merged commit 9959b88 into denoland:main Jan 20, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants