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: Add documentation to a subset of available extensions #24138

Merged
merged 18 commits into from
Jun 17, 2024

Conversation

rscarson
Copy link
Contributor

@rscarson rscarson commented Jun 7, 2024

I was able to use my experience with some of the Deno extensions to flesh out their documentation a bit

I've provided docs for the following:

  • web
  • fetch
  • net
  • webidl
  • url
  • io
  • crypto
  • console

The only code change I have made is to formalize the previously undocumented dependency between deno_io and deno_tty

I do plan to eventually add support in my own crate for all deno extensions, and plan to document them as I get through them

If there are internal guidelines for documentation which I am not adhering to, I will happily modify these to match them

@CLAassistant
Copy link

CLAassistant commented Jun 7, 2024

CLA assistant check
All committers have signed the CLA.

@crowlKats
Copy link
Member

i am in favour of making the documentation more expansive, however having the ops seems a bit much, as these will most likely get out of date

@rscarson
Copy link
Contributor Author

rscarson commented Jun 7, 2024

i am in favour of making the documentation more expansive, however having the ops seems a bit much, as these will most likely get out of date

deno_net already provided such a list, I tried to match that

Also to be fair, most documentation goes out of date on a regular basis, especially with APIs that change as quickly as this one

I expect a lot of the JS side to change often too, like the change to move timers away from deno_web for example

@rscarson
Copy link
Contributor Author

Linter has now accepted the formatting; unsure why checks are still failing

@rscarson rscarson changed the title Add documentation to a subset of available extensions Docs: Add documentation to a subset of available extensions Jun 16, 2024
@rscarson
Copy link
Contributor Author

Adjusted pr title as per lint

@rscarson rscarson changed the title Docs: Add documentation to a subset of available extensions docs: Add documentation to a subset of available extensions Jun 16, 2024
Copy link
Member

@bartlomieju bartlomieju 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!

@bartlomieju bartlomieju merged commit 257f027 into denoland:main Jun 17, 2024
17 checks passed
bartlomieju pushed a commit that referenced this pull request Jun 18, 2024
I was able to use my experience with some of the Deno extensions to
flesh out their documentation a bit

I've provided docs for the following:
- web
- fetch
- net
- webidl
- url
- io
- crypto
- console

---------

Signed-off-by: Richard Carson <[email protected]>
zebreus pushed a commit to zebreus/deno that referenced this pull request Jul 8, 2024
…#24138)

I was able to use my experience with some of the Deno extensions to
flesh out their documentation a bit

I've provided docs for the following:
- web
- fetch
- net
- webidl
- url
- io
- crypto
- console

---------

Signed-off-by: Richard Carson <[email protected]>
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.

4 participants