-
Notifications
You must be signed in to change notification settings - Fork 623
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
tracking: complete documentation #3764
Labels
Comments
This was referenced Nov 15, 2023
Closed
xpost: #3878 |
This was referenced Nov 29, 2023
@iuioiua could you update the list here? |
It should be up-to-date as of now. |
This was referenced Dec 4, 2023
This was referenced Dec 11, 2023
This was referenced Dec 18, 2023
This was referenced Jan 4, 2024
This was referenced Jan 11, 2024
magurotuna
added a commit
that referenced
this issue
May 28, 2024
This commit improves docs of the front-matter module. Specifically, the following things are done: - Use `@example` where appropriate to render the examples more beautifully - Split the big example attached to `createExtractor` function into smaller pieces so that each one has minimal yet meaningful example - Add `@returns` to the `test` function - Deduplicate `Format` type definition - Add a brief description to `Format` type Towards #3764 --------- Co-authored-by: Asher Gomez <[email protected]>
magurotuna
added a commit
that referenced
this issue
May 28, 2024
This commit improves docs of the streams module. Towards #3764 --------- Co-authored-by: Yoshiya Hinosawa <[email protected]>
This was referenced May 29, 2024
This was referenced Jun 5, 2024
This was referenced Jun 20, 2024
Can we close this now? |
Not yet. The remaining packages should be documented, even if they're not getting stabilized. Even if they end up getting removed, documenting them will give us a better understanding of them too. |
This was referenced Sep 26, 2024
This was referenced Nov 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Documentation is essential for obvious reasons and key for the stabilization of packages. Requirements for each package:
deno doc --lint <file>
All packages need to have their documentation complete and validated:
dotenv
docs #5095std/io
#5656@std/json
docs #4798@std/testing
#5033@std/toml
docs #4799The text was updated successfully, but these errors were encountered: