Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

against es6 in documentation #431

Closed
forgotPassword opened this issue Dec 30, 2015 · 5 comments
Closed

against es6 in documentation #431

forgotPassword opened this issue Dec 30, 2015 · 5 comments

Comments

@forgotPassword
Copy link

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.

@stevemao
Copy link
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.

@ghost
Copy link

ghost commented Dec 30, 2015

thing is, the latest releases all support most ES6 features out of the box. even the LTS does that, so it's officially encouraged.
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

but what @stevemao says does apply, the pre-4.x docs are still in ES5

@wonderdogone
Copy link
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.

@stevemao
Copy link
Contributor

stevemao commented Jan 1, 2016

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.

@rvagg
Copy link
Member

rvagg commented Jan 14, 2016

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
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants