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

doc: Improve API documentation and add examples for Deno functions #4548

Merged
merged 1 commit into from
Apr 1, 2020

Conversation

cknight
Copy link
Contributor

@cknight cknight commented Mar 31, 2020

This is the final PR in the series of work to update the documentation for the Deno functions API. Every function now has at least one example, greater consistency between functions and better calling out of Windows differences (or missing implementations). Hopefully this will provide a better end user experience.

Specifically, this PR addresses the following function APIs:

  • read/sync
  • readAll/sync
  • realpath/sync
  • remove/sync
  • rename/sync
  • resources
  • run
  • runTests
  • seek/sync
  • setRaw
  • shutdown/sync
  • signal
  • symlink/sync
  • test
  • truncate/sync
  • umask
  • utime/sync
  • write/sync
  • writeAll/sync
  • writeFile/sync

Copy link
Member

@ry ry left a comment

Choose a reason for hiding this comment

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

Amazing work! Thank you @cknight! This certainly improves the experience greatly

@ry ry merged commit 857d960 into denoland:master Apr 1, 2020
@cknight cknight deleted the docUpdate8 branch April 1, 2020 06:30
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.

None yet

2 participants