docs do not state at what version an API was introduced (or deprecated)
node documentation just documents the current node, but to write portable node.js, its important to know about when APIs were introduced (or changed incompatibly)
I regularly find developers attempting to use features that only exist on the most recent Node.js versions, such as the v8
module, without realizing it doesn't exist on some LTS versions.
It would be quite helpful if the API docs were annotated with the version in which an API was introduced.
cc: @chrisdickinson
@bhajian
(edited by @addaleax
)
Now that basic tooling for this feature is available in the doctool, it would be nice to see if we can get some people together for looking up the versions in which features were added/deprecated! If you’d like to volunteer, I’d suggest you just comment on this issue.
Documentation files for which this is definitely worthwhile:
-
assert.md – @Trott
in f52b2f11 (#6688) -
buffer.md – @addaleax
in 4dcc692c (#6495) -
child_process.md – @addaleax
in 27d22670 (#6927) -
cli.md – @Trott
in 90675818 (#6960) -
cluster.md – @addaleax
in c628982a (#7640) -
console.md – @edsadr
in 51b8a79b (#6995) -
crypto.md – @lpinca
in cfe82783 (#8281) -
dgram.md – @lpinca
in 379d9162 (#8196) -
dns.md – @julianduque
in 71996506 (#7021) -
events.md – @lpinca
in 769f63cc (#7822) -
fs.md – @addaleax
in ba10ea8f (#6717) -
http.md – @addaleax
in 72500f94 (#7392) -
https.md – @addaleax
in e8356b25 (#7392) -
modules.md – @lpinca
in df4880de (#8250) -
net.md – @italoacasas
in 8bccc9e6 (#7038) -
os.md – @bengl
in 5a8c66a2 (#6609) -
path.md – @julianduque
in bed44c94 (#6985) -
process.md – @bengl
in ec67abe4 (#6589) -
punycode.md – @firedfox
in b90c52e3 (#6805) -
querystring.md – @bengl
in f7730733 (#6593) -
readline.md – @julianduque
in 0ed4d8c5 (#6996) -
repl.md – @addaleax
in 740d8cf5 (#7256) -
stream.md – @italoacasas
in c897d0ba (#7287) -
string_decoder.md – @Trott
in eb089e7c (#6741) -
tls.md – @italoacasas
in c2e6078e (#7018) -
tty.md – @trott
in d3f3e183 (#6783) -
url.md – @bengl
in 43e4bafc (#6593) -
util.md – @lpinca
in d9142b4b (#8206) -
v8.md – @trott
in b3bc3620 (#6684) -
vm.md – @addaleax
in 16f98e58 (#7011) -
zlib.md – @addaleax
in b49df889 (#6840)
Docs for which this may or may not make sense:
-
addons.md -
debugger.md -
domain.md -
globals.md -
timers.md – @addaleax
in cd4dbf33 (#7493)