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

tracking: complete documentation #3764

Open
37 of 38 tasks
iuioiua opened this issue Nov 2, 2023 · 7 comments
Open
37 of 38 tasks

tracking: complete documentation #3764

iuioiua opened this issue Nov 2, 2023 · 7 comments
Labels

Comments

@iuioiua
Copy link
Contributor

iuioiua commented Nov 2, 2023

Documentation is essential for obvious reasons and key for the stabilization of packages. Requirements for each package:

  1. Pass without error for public entrypoints using deno doc --lint <file>
  2. Adhere to the documentation guidelines.

All packages need to have their documentation complete and validated:

@lucacasonato
Copy link
Member

xpost: #3878

@lino-levan
Copy link
Contributor

@iuioiua could you update the list here?

@iuioiua
Copy link
Contributor Author

iuioiua commented Dec 2, 2023

It should be up-to-date as of now.

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]>
@kt3k
Copy link
Member

kt3k commented Jul 26, 2024

Can we close this now?

@iuioiua
Copy link
Contributor Author

iuioiua commented Jul 26, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants