JSDoc refresh for the sw-routing module #153
Conversation
|
|
||
| **Parameters** | ||
|
|
||
| - `path` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The path to use for routing. | ||
| - `handler` **[function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** The handler to manage the response. | ||
| If the path contains [named parameters](https://github.com/pillarjs/path-to-regexp#named-parameters), | ||
| then an Object mapping parameter names to the corresponding value |
There was a problem hiding this comment.
then an Object mapping parameter names
Names what? I don't understand this sentence.
There was a problem hiding this comment.
"parameter names" is a compound noun, but I could see how it might be interpreted with "names" as a verb.
Would it be clearer rephrased as "the names of parameters"?
| - `handler` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** An Object with a `handle` method. That method | ||
| will be used to respond to matching requests. | ||
| - `method` **\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** Only match requests that use this | ||
| HTTP method. Defaults to `'GET'` if not specified. |
There was a problem hiding this comment.
Just checking. Are the quotes intended to be part of this literal string?
There was a problem hiding this comment.
If you change it, do it throughout. I found it at least one other place.
There was a problem hiding this comment.
Yeah, it was intentional, but if as a matter of style you'd prefer 'GET', I'm fine with that too.
There was a problem hiding this comment.
The point of quotation marks is to set the thing off visually, believe it or not. We get that by virtue of the monospaced font. If it's not part of the literal, take it out.
There was a problem hiding this comment.
The single quotes are there to indicate that 'GET' is a string literal. They aren't optional here.
The backticks are a matter of style when it's already obvious that it's a string literal. I tend to be super-over-backtick-zealous, so feel free to edit those out.
R: @addyosmani @gauntface @jpmedley
Fixes #150
Refresh of the
sw-routingJSDocs. It errs on the wordy side right now...