Skip to content

docs do not state at what version an API was introduced (or deprecated) #6578

Closed
@sam-github

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.

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:

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to the documentations.feature requestIssues that request new features to be added to Node.js.good first issueIssues that are suitable for first-time contributors.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions