Repository navigation
docs do not state at what version an API was introduced (or deprecated) #6578
Description
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.
(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 f52b2f1 (doc: add
added:information for assert #6688) - buffer.md – @addaleax in 4dcc692 (tools: parse documentation metadata (take 2) #6495)
- child_process.md – @addaleax in 27d2267 (doc: add
added:information for child_process #6927) - cli.md – @Trott in 9067581 (doc: add
added:data for cli.md #6960) - cluster.md – @addaleax in c628982 (doc: add
added:information for cluster #7640) - console.md – @edsadr in 51b8a79 (doc: add
added:information for console #6995) - crypto.md – @lpinca in cfe8278 (doc: add
added:information for crypto #8281) - dgram.md – @lpinca in 379d916 (doc: add
added:information for dgram #8196) - dns.md – @julianduque in 7199650 (doc: add
added:information for dns #7021) - events.md – @lpinca in 769f63c (doc: add
added:information for events #7822) - fs.md – @addaleax in ba10ea8 (doc: add
added:information for fs #6717) - http.md – @addaleax in 72500f9 (doc: add
added:information for http(s) #7392) - https.md – @addaleax in e8356b2 (doc: add
added:information for http(s) #7392) - modules.md – @lpinca in df4880d (doc: add
added:information for modules #8250) - net.md – @italoacasas in 8bccc9e (doc: add
added:information for net #7038) - os.md – @bengl in 5a8c66a (doc: add
added:information for os #6609) - path.md – @julianduque in bed44c9 (doc: add
added:information for path #6985) - process.md – @bengl in ec67abe (doc: add
added:information for process #6589) - punycode.md – @firedfox in b90c52e (doc: add
added:information for punycode #6805) - querystring.md – @bengl in f773073 (doc: add
added:information for url, querystring #6593) - readline.md – @julianduque in 0ed4d8c (doc: add
added:information for readline #6996) - repl.md – @addaleax in 740d8cf (doc: add
added:information for repl #7256) - stream.md – @italoacasas in c897d0b (doc: add
added:information for stream #7287) - string_decoder.md – @Trott in eb089e7 (doc: add
added:info forstring_decoder#6741) - tls.md – @italoacasas in c2e6078 (doc: add
added:information for tls #7018) - tty.md – @Trott in d3f3e18 (doc: add
added:in fortty#6783) - url.md – @bengl in 43e4baf (doc: add
added:information for url, querystring #6593) - util.md – @lpinca in d9142b4 (doc: add
added:information for util #8206) - v8.md – @Trott in b3bc362 (doc: add
added:information for v8 #6684) - vm.md – @addaleax in 16f98e5 (doc: add
added:information for vm #7011) - zlib.md – @addaleax in b49df88 (doc: add
added:information for zlib #6840)
Docs for which this may or may not make sense:
- addons.md
- debugger.md
- domain.md
- globals.md
- timers.md – @addaleax in cd4dbf3 (doc: add
added:information for timers #7493)
Activity
jasnell commentedon May 4, 2016
See: #6495
/cc @addaleax
addaleax commentedon May 4, 2016
Yep, I guess I can land that one now.
@sam-github If you don’t mind, I’d like to use this issue (edit your original comment) to keep a list of the doc files for which this work needs to be done and tag this good-first-contribution?
MylesBorins commentedon May 4, 2016
that sounds like an excellent idea @addaleax
addaleax commentedon May 5, 2016
@thealphanerd @sam-github @bengl Looking good to everybody? Is this something you can share via social media in this state? :)
bengl commentedon May 5, 2016
tweeted: https://twitter.com/bengl/status/728016045110222848
Also, I'm unclear on this: some features were added in one version and then only documented in another. Which versions should the
addedfield represent?addaleax commentedon May 5, 2016
@bengl The version in which it was added, not the one in which it was documented. :)
299 remaining items
doc: add `added:` information for cluster
lpinca commentedon Oct 2, 2016
@italoacasas are you still up for
globals.md?italoacasas commentedon Oct 2, 2016
@lpinca I forgot about this completely, I'm a little busy right now with some tests, but I'm going to tackle this down in a week if no one does first.
lpinca commentedon Oct 2, 2016
@italoacasas sure, just let me know if you don't have the time. I would really like to see this completed.
italoacasas commentedon Oct 2, 2016
@lpinca well If someone else wants to make
globals.mdupdate, feel free, please. I don't want to stop anyone contribution.If when I finish the
streamtests,globals.mdstill undone, I will do the update.doc: add `added:` information for globals
doc: add `added:` information for globals
doc: add `added:` information for globals
doc: add `added:` information for cluster
doc: add `added:` information for globals
doc: add `added:` information for globals
targos commentedon May 30, 2017
@sam-github is this fully resolved?
addaleax commentedon May 30, 2017
I think this can be closed now, yes.