docs(reference): updates reference docs for 3.0.0 #1607
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mbroadst
suggested changes
Dec 8, 2017
|
|
||
| ECMAScript Next (also know as ESNext, ES2015, ES6, and many other names) is the new future of the Javascript language. It introduces fundamental changes in JavaScript while maintaining backward compatibility with ECMAScript 5. | ||
|
|
||
| The MongoDB Node.js driver embraces the new JavaScript version to provide the end user with much improved functionality. We do this primarily by exposing Promises for all `async` methods without breaking backward compatibility with existing code using the driver. |
There was a problem hiding this comment.
Can we reword this a little?
The MongoDB Node.js driver embraces modern JavaScript by optionally returning Promises from all async methods.
something like that?
|
|
||
| The MongoDB Node.js driver embraces the new JavaScript version to provide the end user with much improved functionality. We do this primarily by exposing Promises for all `async` methods without breaking backward compatibility with existing code using the driver. | ||
|
|
||
| This section exposes how to use the MongoDB Node.js driver with ESNext6, leveraging all the productivity gains you get from the new Generators. |
There was a problem hiding this comment.
Also let's not talk about generators :)
| var logger = Logger('A', options); | ||
| class A { | ||
| constructor() { | ||
| this.logger = Logger('A'); |
There was a problem hiding this comment.
I think this is actually required to be new Logger('A') (see: https://github.com/mongodb-js/mongodb-core/blob/3.0.0/lib/connection/logger.js#L25)
mbroadst
approved these changes
Dec 8, 2017
This was referenced Mar 8, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updating the "Reference" part of the reference docs for 3.0.0