Sitelet https://github.com/nodejs/nodejs.org/issues/431
Skip to content

against es6 in documentation #431

Description

@forgotPassword

i don't know if it was decided/voted or not, but i am against es6 features in documentation or code examples.
the docs and examples should be as simple as possible, and now even the classic createServer example ('about' page) has const, arrow functions, and template strings.

before you could just say 'copy this example, see how easy it is to create a server in node?', now you also have to explain what all those special signs and characters are.

Activity

  1. stevemao commented on Dec 30, 2015

    @stevemao
    Contributor

    I believe these examples are in the docs of nodejs that support them. If you switch to an older version they shouldn't be there.

  2. wonderdogone commented on Dec 30, 2015

    @wonderdogone
    Contributor

    I think it's good to push ES6 unless it's a feature set that is outside of Node internally. For example some ES6 that needs to be transpiled by external tool like babel should not be in docs because then you have to explain that workflow.

  3. stevemao commented on Jan 1, 2016

    @stevemao
    Contributor

    but what we might be able to do is add a link to an ES6 introduction under the code example on the about page in case someone is confused

    I don't think this is necessary. We already have docs about features in es2015. If we add a link to all the pages that have es2015 code it would be too noisy. Not to mention that there are many people already using es2015 and a there are a lot of material about es2015 online.

    Closing this now. @forgotPassword if you find anything that does not work against the corresponding node version out of the box please fire a bug :) thanks.

  4. rvagg commented on Jan 14, 2016

    @rvagg
    Member

    Thanks for the link @stevemao, I knew there was an issue in here about this recently that I couldn't find.

    Folks in here, please see #467 for possible way forward. Only discussion at this stage.

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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions