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
Added warning that module names exist in URL space #2322
Conversation
Added a warning that module names exist in URL space, so should be / separated. In reference to systemjs/builder#814.
``` | ||
jspm bundle app/main build.js | ||
``` | ||
|
||
Creates a file `build.js` containing `app/main` and all its dependencies referenced in config.js. | ||
Creates a file `build.js` containing `app/main` and all its dependencies referenced in config.js. \ |
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.
Why the trailing /
?
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.
To force a newline! I guess what happens is that in my editor, md renders differently from github (despite being set for gfm). It should be trivial enough for you to fix :)
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.
Thank you for this! Looks good to me except for the nit regarding /
below
@@ -6,11 +6,12 @@ There are three main workflows for production: | |||
|
|||
### Creating a Bundle | |||
|
|||
***Important**: The module names such as `app/main` used in the examples below should only be `/` separated (On Windows, do NOT use `\` as your path separator for this argument). The module names are specified in URL space; in particular, they are not file-paths.* |
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.
I think this should be reworded slightly. It should say something closer to what the title of this PR says. Also, I think Note: would be better than Important.
I don't mind rewording as long as users are not confused about it (like I
was)...
…On 27 October 2017 at 19:15, Aluan Haddad ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In docs/production-workflows.md
<#2322 (comment)>:
> @@ -6,11 +6,12 @@ There are three main workflows for production:
### Creating a Bundle
+***Important**: The module names such as `app/main` used in the examples below should only be `/` separated (On Windows, do NOT use `\` as your path separator for this argument). The module names are specified in URL space; in particular, they are not file-paths.*
I think this should be reworded slightly. It should say something closer
to what the title of this PR says. Also, I think *Note*: would be better
than *Important*.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#2322 (review)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AClLM0wFJmIaZS5gTrVg1U0wycHN3FMCks5swd5kgaJpZM4OIQXj>
.
|
Agreed. |
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.
I don't think any rewording is necessary after all. Thank you for your contribution!
Added a warning that module names exist in URL space, so should be / separated. In reference to systemjs/builder#814.