DOC-593 firstLoadingAnimation: fixed inconsistencies with Developers doc #379
Conversation
fbeaudoincoveo
commented
Feb 28, 2017
fbeaudoincoveo
commented
- Also made some minor cosmetic changes to the SearchInterface documentation.
- Also made some minor cosmetic changes to the SearchInterface documentation.
| @@ -209,6 +209,9 @@ export class ResultList extends Component { | |||
| * If {@link ResultList.options.enableInfiniteScroll} is `true`, specifies the element that triggers the fetching of | |||
| * additional results when the end user scrolls down to its bottom. | |||
| * | |||
| * You can change the container by specifying its selector (e.g., | |||
There was a problem hiding this comment.
I added this because this option is built with ComponentOptions.buildChildHtmlElementOption. Please make sure what I wrote is actually right :)
| @@ -138,7 +138,7 @@ export class SearchInterface extends RootComponent implements IComponentBindings | |||
| * > {@link Facet.options.dropdownHeaderLabel} and {@link Tab.options.dropdownHeaderLabel}). | |||
| * > | |||
| * > Furthermore, it is possible to specify the pixel threshold at which Facet components will go in responsive | |||
| * > mode (see {@link Facet.options.responsiveBreakpoint}. | |||
| * > mode (see {@link Facet.options.responsiveBreakpoint}). | |||
There was a problem hiding this comment.
We modified that, but the doc has not been adjusted.
The breakpoint is no longer specified per component. It's a global setting, on the search interface component (SearchInterface.responsiveComponents).
So this should be modified.
There was a problem hiding this comment.
Thanks! Should I also deprecate Facet.options.responsiveBreakpoint then?
- Some other slight documentation adjustments
src/ui/Facet/Facet.ts
Outdated
| */ | ||
| responsiveBreakpoint: ComponentOptions.buildNumberOption({ defaultValue: 800 }), | ||
| responsiveBreakpoint: ComponentOptions.buildNumberOption({ defaultValue: 800, deprecated: 'This option is exposed for legacy reasons, and the recommendation is to not use this option.' }), |
There was a problem hiding this comment.
It does not work anymore so you should probably recommend to use SearchInterface.responsiveComponents here.
There was a problem hiding this comment.
Yes, I did exactly this in the previous commit :)
There was a problem hiding this comment.
I would also go as far as completely removing the JSDOC for deprecated doc. It serves pretty much no purposes, and only pollutes the doc website with useless info.
There was a problem hiding this comment.
I just realized I understood what you said the other way around ;)
I'll make a new commit to fix this.
src/ui/Facet/Facet.ts
Outdated
| */ | ||
| responsiveBreakpoint: ComponentOptions.buildNumberOption({ defaultValue: 800 }), | ||
| responsiveBreakpoint: ComponentOptions.buildNumberOption({ defaultValue: 800, deprecated: 'This option is exposed for legacy reasons, and the recommendation is to not use this option.' }), |
There was a problem hiding this comment.
I would also go as far as completely removing the JSDOC for deprecated doc. It serves pretty much no purposes, and only pollutes the doc website with useless info.
…deprecated option JSDOC instead...
