docs(formatter): improvements to currency, date, filter, and formatter #1008
Conversation
|
I'm not done with filter, but it's a start. @kwalrath (or anyone else) if you have any comments on doc style, I'd love to hear them. I'm trying to make our overall style more consistent with dartdoc. |
| * | ||
| * - `expression` (required) - one of [Map], [Function], [String], [bool], [num] | ||
| * - `comparator` (optional) | ||
| * <div ng-repeat="item in items | filter:_expression_[:_comparator_]"> |
There was a problem hiding this comment.
I'm using underscore here to reflect things that are user specified. Does that look right to you?
There was a problem hiding this comment.
To me the explanation below should be enough. Is underscore used somewhere else ?
There was a problem hiding this comment.
Yes, underscore is something we have used in passed.
| * | ||
| * [leading]: Symbol should be placed in front of the number | ||
| * - `value`: the value to format as currency. |
There was a problem hiding this comment.
Out of curiosity: why [] has in been in favor of `` ?
There was a problem hiding this comment.
I believe that [] creates a link where as `` only changes the font to monospace.
There was a problem hiding this comment.
And which one is better ?
(I'm asking because the Dart source files use "[]" to document method args)
There was a problem hiding this comment.
I'd say it's a matter of taste. I personally find unnecessary links annoying.
There was a problem hiding this comment.
I'm slowly going through and replacing [ ] that just point back to the same dartdoc page with ``. I think it's confusing to the reader to click something link-like and then realise it only took them a few lines up to the header, and didn't provide any new information.
No description provided.