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:
Docs for which this may or may not make sense:
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
v8module, 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:
added:information for assert #6688)added:information for child_process #6927)added:data for cli.md #6960)added:information for cluster #7640)added:information for console #6995)added:information for crypto #8281)added:information for dgram #8196)added:information for dns #7021)added:information for events #7822)added:information for fs #6717)added:information for http(s) #7392)added:information for http(s) #7392)added:information for modules #8250)added:information for net #7038)added:information for os #6609)added:information for path #6985)added:information for process #6589)added:information for punycode #6805)added:information for url, querystring #6593)added:information for readline #6996)added:information for repl #7256)added:information for stream #7287)added:info forstring_decoder#6741)added:information for tls #7018)added:in fortty#6783)added:information for url, querystring #6593)added:information for util #8206)added:information for v8 #6684)added:information for vm #7011)added:information for zlib #6840)Docs for which this may or may not make sense:
added:information for timers #7493)