-
Notifications
You must be signed in to change notification settings - Fork 47k
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
Add target option to npm readme #3636
Conversation
I found another missing option: |
@@ -45,6 +46,7 @@ option | values | default | |||
`stripTypes` | `true`: strips out type annotations | `false` | |||
`es6module` | `true`: parses the file as an ES6 module | `false` | |||
`nonStrictEs6module` | `true`: parses the file as an ES6 module, except disables implicit strict-mode (i.e. CommonJS modules et al are allowed) | `false` | |||
`target` | `"es3"`: ECMAScript 3<br>`"es5"`: ECMAScript 5| `"es5"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Markdown files don't usually have
elements, do they? Usually markdown is intended to be both human and machine readable, to the extent possible, right? cc @zpao who will know best.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is allowed to have html elements. At least <iframe>
is already used in the docs for inline videos. Here this is explained: Inline HTML.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, but is it good style? Is it what we want to do here? My understanding (which is admittedly limited) is that we want to avoid HTML in the markdown files whenever possible. In the case of a linebreak, it seems avoidable, but maybe it's necessary/desirable here because we're in a table. Another option would be to use a coma or other form of punctuation. instead of a br
. I don't have a strong preference here, mostly just flagging it for @zpao to take a look and make a call.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea, that's allowed. Note, you can always view the rendered output on github, even in PRs.
Thanks! And don't worry about the |
Add target option to npm readme
Add target option to npm readme
Add target option to npm readme
Target is the last option missing in the readme.