Skip to content

Add supported Node.js versions in latest Docs #6470

Description

@PatrickHeneise
  • Version: 6

Search engines usually show the latest docs for Node.js. Today I had the frustrating task to debug why my Buffer.from(string, encoding) function worked perfectly fine on my developer machine but threw a TypeError 'binary' is not a function. It took me a while to realise I'm running Node 4 LTS on staging and of course Node 6 on the dev machine and that Buffer.from is not working in 4 LTS, but already deprecated in 6. Worse is that Buffer.from() should have thrown the non-existing function error, as it's not listed in the v4 docs.

I think it would be great help to have the supported versions for each function in the latest documentation to see when a function has been introduced and when it gets deprecated, best with colours ranging from green, orange and red (just an idea), to indicate right away the status.

Activity

  1. added
    docIssues and PRs related to Node.js documentation.
    on Apr 29, 2016
  2. cjihrig commented on Apr 29, 2016

    @cjihrig
    Contributor

    cc: @nodejs/documentation

  3. jasnell commented on Apr 29, 2016

    @jasnell
    Member

    There was a previous effort to do this that stalled out because the person working on it ended up getting busy on other work. Would love to see this revisited.

  4. addaleax commented on Apr 29, 2016

    @addaleax
    Member

    There’s #3713 and the doctool support PR in #3867. I’ve asked to rebase the latter one because I’d love to work on this, but no response so far.

  5. added
    duplicateIssues and PRs that are duplicates of other issues or PRs.
    on May 1, 2016
  6. addaleax commented on May 1, 2016

    @addaleax
    Member

    Closing this as a duplicate of #3713, and I’m working on this in #6495.

  7. added a commit that references this issue on May 17, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to Node.js documentation.duplicateIssues and PRs that are duplicates of other issues or PRs.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions