Chromium Code Reviews
|
|
Chromium Code Reviews
Issue
2920373002:
Update DDC Readme (Closed)
|
Created:
3 years, 6 months ago by vsm Modified:
3 years, 6 months ago Reviewers:
Bob Nystrom CC:
dev-compiler+reviews_dartlang.org, Kathy Walrath, Jennifer Messerly Target Ref:
refs/heads/master Visibility:
Public. |
DescriptionUpdate DDC Readme
R=rnystrom@google.com
Staging: https://github.com/dart-lang/sdk/blob/ddc-readme/pkg/dev_compiler/README.md
Committed: https://github.com/dart-lang/sdk/commit/532d9eabc797721298a83889ca5cabe9dc8a06c9
Patch Set 1 #
Total comments: 20
Patch Set 2 : Address comments #Messages
Total messages: 7 (3 generated)
Description was changed from ========== Update DDC Readme Staging: https://github.com/dart-lang/sdk/blob/ddc-readme/pkg/dev_compiler/README.md ========== to ========== Update DDC Readme Staging: https://github.com/dart-lang/sdk/blob/ddc-readme/pkg/dev_compiler/README.md ==========
vsm@google.com changed reviewers: + rnystrom@google.com
Present tense is usually better for technical writing. It's shorter and more direct. LGTM! https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md File pkg/dev_compiler/README.md (right): https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:6: The Dart Dev Compiler (DDC) is a fast, modular compiler that generates modern JavaScript (EcmaScript 6). Its primary use today to support fast, iterative development of Dart for web applications on Chrome and other modern browers. "today to" -> "today is to". I don't think "Dart for web" reads as a single noun for most people, so the end of the sentence is a little awkward. Maybe: "Its primary use today is to support fast, iterative development of Dart web applications for Chrome and other modern browers." https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:8: Most users will use DDC via [pub](https://webdev.dartlang.org/tools/pub/pub-serve). It will be supported by pub starting with the Dart 1.24 release. "will be" -> "is". https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:20: List<int> list2 = list; // Static type error: incompatible types Nit: Indentation isn't needed here. https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:28: List<int> list3 = list2; // Implicit runtime downcast triggers error Nit: Add "." at end of comment. https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:38: Most users will invoke DDC indirectly via [pub](https://webdev.dartlang.org/tools/pub/pub-serve). Pub will compute module structure and build steps automatically and invoke DDC accordingly. Pub configures DDC to use AMD modules and uses the standard [AMD `require.js` loader](http://requirejs.org/) to bootstrap and load the application. "will invoke" -> "invoke". "will compute" -> "computes". https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:40: More advanced users may want to configure or invoke DDC directly. In general, the mapping of Dart files to JS modules is flexible. The key requirement is that module dependences (i.e., `require` in AMD or CommonJS or `import` in ES6) must be acyclic. In practice, this means that individual Dart libraries cannot each be mapped to a corresponding JS module (as Dart imports can be cyclic). See the [usage document](USAGE.md) for more details. Maybe "can be" -> "can be and often are". https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:44: DDC attempts to map Dart to idiomatic EcmaScript 6 (ES6) as cleanly as possible, and it relies heavily on static typing to do this. In general, where Dart concepts map directly to ES6, DDC will generate code accordingly. For example, Dart classes are mapped to ES6 classes, Dart fields to ES6 properties, Dart getters/setters to ES6 getters/setters, Dart methods to ES6 methods, and so on. In most cases, names will be preserved and calling conventions will be natural JavaScript ones. "will be" -> "are". https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:44: DDC attempts to map Dart to idiomatic EcmaScript 6 (ES6) as cleanly as possible, and it relies heavily on static typing to do this. In general, where Dart concepts map directly to ES6, DDC will generate code accordingly. For example, Dart classes are mapped to ES6 classes, Dart fields to ES6 properties, Dart getters/setters to ES6 getters/setters, Dart methods to ES6 methods, and so on. In most cases, names will be preserved and calling conventions will be natural JavaScript ones. "will generate" -> "generates". https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:53: - *Scoping*. Dart scoping rules and reserved words are slightly different than JavaScript. While we try to preserve names wherever possible, in certain cases, we may be required to rename. "may be" -> "are". https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:59: DDC currently supports Chrome stable (though users have had success running on FireFox and Safari). In the near future, we expect to run all common modern browsers that support ES6. ES6 itself is in active development across all modern browsers, but at advanced stages of support: "run all" -> "target all".
thanks! https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md File pkg/dev_compiler/README.md (right): https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:6: The Dart Dev Compiler (DDC) is a fast, modular compiler that generates modern JavaScript (EcmaScript 6). Its primary use today to support fast, iterative development of Dart for web applications on Chrome and other modern browers. On 2017/06/05 21:50:51, Bob Nystrom wrote: > "today to" -> "today is to". > > I don't think "Dart for web" reads as a single noun for most people, so the end > of the sentence is a little awkward. Maybe: > > "Its primary use today is to support fast, iterative development of Dart web > applications for Chrome and other modern browers." Done. https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:8: Most users will use DDC via [pub](https://webdev.dartlang.org/tools/pub/pub-serve). It will be supported by pub starting with the Dart 1.24 release. On 2017/06/05 21:50:51, Bob Nystrom wrote: > "will be" -> "is". Done. https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:20: List<int> list2 = list; // Static type error: incompatible types On 2017/06/05 21:50:50, Bob Nystrom wrote: > Nit: Indentation isn't needed here. Done. https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:28: List<int> list3 = list2; // Implicit runtime downcast triggers error On 2017/06/05 21:50:51, Bob Nystrom wrote: > Nit: Add "." at end of comment. Done. https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:38: Most users will invoke DDC indirectly via [pub](https://webdev.dartlang.org/tools/pub/pub-serve). Pub will compute module structure and build steps automatically and invoke DDC accordingly. Pub configures DDC to use AMD modules and uses the standard [AMD `require.js` loader](http://requirejs.org/) to bootstrap and load the application. On 2017/06/05 21:50:51, Bob Nystrom wrote: > "will invoke" -> "invoke". > > "will compute" -> "computes". Done. https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:40: More advanced users may want to configure or invoke DDC directly. In general, the mapping of Dart files to JS modules is flexible. The key requirement is that module dependences (i.e., `require` in AMD or CommonJS or `import` in ES6) must be acyclic. In practice, this means that individual Dart libraries cannot each be mapped to a corresponding JS module (as Dart imports can be cyclic). See the [usage document](USAGE.md) for more details. On 2017/06/05 21:50:51, Bob Nystrom wrote: > Maybe "can be" -> "can be and often are". Done. https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:44: DDC attempts to map Dart to idiomatic EcmaScript 6 (ES6) as cleanly as possible, and it relies heavily on static typing to do this. In general, where Dart concepts map directly to ES6, DDC will generate code accordingly. For example, Dart classes are mapped to ES6 classes, Dart fields to ES6 properties, Dart getters/setters to ES6 getters/setters, Dart methods to ES6 methods, and so on. In most cases, names will be preserved and calling conventions will be natural JavaScript ones. On 2017/06/05 21:50:51, Bob Nystrom wrote: > "will be" -> "are". Done. https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:44: DDC attempts to map Dart to idiomatic EcmaScript 6 (ES6) as cleanly as possible, and it relies heavily on static typing to do this. In general, where Dart concepts map directly to ES6, DDC will generate code accordingly. For example, Dart classes are mapped to ES6 classes, Dart fields to ES6 properties, Dart getters/setters to ES6 getters/setters, Dart methods to ES6 methods, and so on. In most cases, names will be preserved and calling conventions will be natural JavaScript ones. On 2017/06/05 21:50:51, Bob Nystrom wrote: > "will generate" -> "generates". Done. https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:53: - *Scoping*. Dart scoping rules and reserved words are slightly different than JavaScript. While we try to preserve names wherever possible, in certain cases, we may be required to rename. On 2017/06/05 21:50:51, Bob Nystrom wrote: > "may be" -> "are". Done. https://codereview.chromium.org/2920373002/diff/1/pkg/dev_compiler/README.md#... pkg/dev_compiler/README.md:59: DDC currently supports Chrome stable (though users have had success running on FireFox and Safari). In the near future, we expect to run all common modern browsers that support ES6. ES6 itself is in active development across all modern browsers, but at advanced stages of support: On 2017/06/05 21:50:50, Bob Nystrom wrote: > "run all" -> "target all". Done.
Description was changed from ========== Update DDC Readme Staging: https://github.com/dart-lang/sdk/blob/ddc-readme/pkg/dev_compiler/README.md ========== to ========== Update DDC Readme R=rnystrom@google.com Staging: https://github.com/dart-lang/sdk/blob/ddc-readme/pkg/dev_compiler/README.md Committed: https://github.com/dart-lang/sdk/commit/532d9eabc797721298a83889ca5cabe9dc8a06c9 ==========
Message was sent while issue was closed.
Committed patchset #2 (id:20001) manually as 532d9eabc797721298a83889ca5cabe9dc8a06c9 (presubmit successful). |
