0
0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00
nodejs/doc
Vse Mozhet Byt 7108893ec8 doc: clarify fs.write[Sync]() descriptions
1. All default values for optional `encoding` parameters
   were documented except for the one in `fs.write(fd, string...)`
   method. This PR makes up this deficiency.

2. We have two variants of `fs.write()` / `fs.writeSync()` methods:
   for buffers and strings. Currently, the sync methods have only one
   common reference to the full description of async methods.
   However, the link may seem to belong to the last sync variant only
   (for strings) and, as it refers to the first async variant
   (for buffers), this may be confusing. This PR makes two different
   sync variants refer to two different async variants.

3. In passing, both returned values of sync methods were also made
   more concise and unambiguous.

PR-URL: https://github.com/nodejs/node/pull/22402
Refs: a04f2f7df6/lib/fs.js (L549)
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2018-08-19 21:52:14 +03:00
..
api doc: clarify fs.write[Sync]() descriptions 2018-08-19 21:52:14 +03:00
api_assets doc: add "Edit on GitHub" link 2018-07-13 20:37:05 -07:00
changelogs 2018-08-15, Version 10.9.0 (Current) 2018-08-16 11:52:38 +10:00
guides doc: replace _WG_ with _team_ 2018-08-08 16:20:30 -07:00
.eslintrc.yaml tools: lint doc code examples in strict mode 2018-07-06 08:45:34 +03:00
first_timer_badge.png
full-white-stripe.jpg
node.1 doc: add doc for --loader option 2018-08-18 11:15:37 +03:00
offboarding.md doc: add offboarding doc 2018-06-05 15:22:15 -07:00
onboarding-extras.md doc: move upstream information to onboarding doc 2018-06-01 14:01:10 +02:00
onboarding.md doc: do not advise to cancel full CI on onboarding 2018-07-26 18:01:31 +03:00
osx_installer_logo.png
releases.md doc: fix typo in releases.md 2018-07-27 08:30:12 +03:00
STYLE_GUIDE.md doc: wrap style guide at 80 characters 2018-06-16 07:54:32 -07:00
template.html doc: add "Edit on GitHub" link 2018-07-13 20:37:05 -07:00
thin-white-stripe.jpg