YouTubeThumbnail doc revision (DOC-458) #304
Conversation
fbeaudoincoveo
commented
Feb 2, 2017
fbeaudoincoveo
commented
I went a little bit further than a simple spell check for those first few components. I will limit myself to a quick spell checks for the next components, though.
- Added link to IGroupByRequest interface. - Made a tiny correction. - Changed HTML link to markdown link.
- Reexposing selectSuggestion(suggestion: number) instead of selectSuggestion(suggestion: any) in public documentation.
…ation: - "Standardized" bindings description in constructor documentation.
- Corrected a leftover spelling mistake. - Some rephrasing and improvements. - Unexposed options (this component has no option). - Unexposed validLayouts static attribute (redundant with ValidLayout type) and currentLayout attribute (redundant with getCurrentLayout() method). - Linked to ValidLayout type documentation.
| * | ||
| * The default value is `200px` | ||
| * Default value is `200px`. | ||
| */ |
There was a problem hiding this comment.
In the generated doc site, the markup configuration example is:
data-height='foo'
If possible, it would be better to display something like:
data-height='100px'
There was a problem hiding this comment.
We would need to have a specific type for "Sizes", and then in the Typedoc project, have a way to recognize that type specifically and generate correct examples.
It would make a lot of sense to have a dedicated type for options that requires size. It would be helpful in the Interface Editor also.
If you are interested we can pass some time together and I can give you a crash course :)
| * | ||
| * The default value is `112px` | ||
| * Default value is `112px`. | ||
| */ |
There was a problem hiding this comment.
See previous comment
| * | ||
| * The default value is `200px` | ||
| * Default value is `200px`. | ||
| */ |
There was a problem hiding this comment.
We would need to have a specific type for "Sizes", and then in the Typedoc project, have a way to recognize that type specifically and generate correct examples.
It would make a lot of sense to have a dedicated type for options that requires size. It would be helpful in the Interface Editor also.
If you are interested we can pass some time together and I can give you a crash course :)
