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

API doc improvments #4525

Merged
merged 3 commits into from
Mar 30, 2020
Merged

API doc improvments #4525

merged 3 commits into from
Mar 30, 2020

Conversation

cknight
Copy link
Contributor

@cknight cknight commented Mar 29, 2020

Further improvements and examples for API docs. This round includes updates to:

  • loadavg
  • hostname
  • env (fix overload function docs)
  • open/openSync
  • read/readSync
  • readAll/readAllSync
  • mkdir/mkdirSync
  • makeTempDir/makeTempDirSync
  • makeTempFile/makeTempFileSync
  • readFile/readFileSync
  • readdir/readdirSync
  • readlink/readlinkSync
  • lstat/lstatSync
  • listen
  • listenTLS
  • connect
  • metrics

Copy link
Contributor

@kitsonk kitsonk left a comment

Choose a reason for hiding this comment

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

LGTM

These are awesome contributions! Thanks for the hard work.

@dubiousjim
Copy link
Contributor

dubiousjim commented Mar 29, 2020

I wish my filesystem PRs would get reviewed and merged before we did document updates on filesystem stuff. It's going to be a chore to fix the merge conflicts.

EDIT: Sorry, I could express that more constructively. I've got more than 10 PRs waiting to be pushed that also include substantive changes to the documentation for a bunch of these functions. But I can't push them until #4448 is decided on. Whatever happens, I'll rebase my filesystem work so it can still be used. But all the rebasing does get tiring...

@kitsonk
Copy link
Contributor

kitsonk commented Mar 29, 2020

@dubiousjim while I am a long term contributor with quite a bit of influence, I am afraid I can't merge PRs. I haven't been reviewing yours personally, because it isn't an area that I feel I have a super good understanding of, plus the time I can dedicate to Deno is quite limited, so I do what I can when I can.

@dubiousjim
Copy link
Contributor

I didn't aim to be complaining, I started writing the comment just to point out there are going to be conflicts. But I guess I was tired of rebasing and conflict fixing. Sorry that it came out as it did. Nothing but props for @cknight!

@kitsonk
Copy link
Contributor

kitsonk commented Mar 29, 2020

@dubiousjim you raised a valid point... ageing PRs are a problem.

@cknight
Copy link
Contributor Author

cknight commented Mar 29, 2020

Sorry @dubiousjim, and here was me thinking to take this on to get out of your way and let you catch up on your file system changes! Give me a shout if you want help resolving the conflicts.

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.

LGTM - thanks!

@ry ry merged commit e88dcdc into denoland:master Mar 30, 2020
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

4 participants