-
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
docs(path): improve API docs #4900
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4900 +/- ##
==========================================
+ Coverage 92.02% 92.12% +0.09%
==========================================
Files 488 487 -1
Lines 38900 38772 -128
Branches 5395 5388 -7
==========================================
- Hits 35797 35717 -80
+ Misses 3047 2999 -48
Partials 56 56 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see quite a few instances of improper casing and partial sentences. Can you please fix those?
Co-authored-by: Asher Gomez <ashersaupingomez@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've fixed quite a few nits and added a few improvements. Though, I think there's a bit more work to do here:
- Mention the differences in behavior for OS-dependent APIs.
- Add
../path/posix/mod.ts
and../path/windows/mod.ts
to the Super Linter, and document everything in those directories. We should get top-level documentation to a good state, then just copy the relevant details over. - Improve the example code snippets (see suggestion).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Big win! Great work!
part of #4600 #3764
supercedes #4839