Wording #123
Wording #123
Conversation
|
While you are at it, see anything else? We might as well catch it with this one and tack it on |
|
@alallier I'll have a look |
|
Would it be a good idea to have a link to the license, rather than just saying |
|
Sure go ahead and do that please |
| -p, --port [port] The port to bind to. Can be set with PORT env variable as well. Defaults to 8080 | ||
| -s, --start-page [start-page] Specify a start page. Defaults to index.html. | ||
| -v, --verbose Turns on logging on the server and client side. Defaults to false. | ||
| -h, --help output usage information |
There was a problem hiding this comment.
Lets try and keep this to just any problems in docs you see like the wording problem. We can spice up and add things at a later time, as I have more doc changes coming later anyways
There was a problem hiding this comment.
The main difference was adding [verbose] to the line 209, so that it looked exactly like the output from reload -h
There was a problem hiding this comment.
Okay that sounds good, why the diff on 201 to 208?
There was a problem hiding this comment.
There isn't any difference. It might be because I am on linux and it is changing the line endings?
There was a problem hiding this comment.
I ran reload -h and copied the output straight from the terminal.
There was a problem hiding this comment.
I see it's the spacing between the first and second columns that is different. This is good though, I like this because it is an exact copy of what reload -h provides.
|
In the Table of Reload Parameters, is it really necessary to call the Basically, can i remove |
|
And do we need curly braces around the |
README.md
Outdated
| ``` | ||
|
|
||
| License | ||
| --- | ||
|
|
||
| (MIT License) | ||
| [(MIT License)](https://github.com/alallier/reload/blob/master/LICENSE) |
There was a problem hiding this comment.
Anyway to make this relative. Kind of like how I did here in the CHANGELOG Please refer to the full API in the [README](README.md#api-for-express). Should be able to reference the file without the URL. Test it out and let me know
There was a problem hiding this comment.
Should I make the link to the expressSampleApp a relative link as well? Or if not, at least change the link from jprichardson to alallier.
There was a problem hiding this comment.
Nice catch, yeah let's doing something with that. I don't know if you can make it relative? Try it out if not, the update from jprichardson to alallier would be great
|
I like how the optional is the description it makes it really clear that it is optional and doesn't hurt to have it in there. The clearer we can be the less questions and problems our users will run into.
|
|
Sorry about the name of that commit. For some reason I thought I could use markdown in the commit. What I meant was Shorten ```javascript to ```js |
README.md
Outdated
| @@ -70,7 +70,7 @@ Reload can be used in conjunction with tools that allow for automatically restar | |||
| ### Express Example | |||
|
|
|||
| **`server.js`:** | |||
| ```javascript | |||
| ```js | |||
There was a problem hiding this comment.
This is unnecessary diff. Let's leave this how it was.
There was a problem hiding this comment.
Change javscript to javascript 6fca6fe
|
Lets get that link updated and get this merged in. |
|
Changed the link to relative 3140125 |
|
Thanks again! |
ghost
deleted the
I know that it's a small detail, but it could really confuse someone.
And fix spacing on line 112