-
Notifications
You must be signed in to change notification settings - Fork 78
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Facet range doc review #303
Conversation
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.
* $("#search").coveo("init", { | ||
* FacetRange : { | ||
* ranges : myRanges | ||
* } | ||
* }) | ||
* ``` | ||
* | ||
* Default value is `null` and the index will automatically generate ranges. | ||
*/ | ||
ranges: ComponentOptions.buildCustomOption<IRangeValue[]>(() => { | ||
return null; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should I expose the constructor?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure. It's not 100% necessary though.
You'll need to fix the conflicts before I can approve this merge. |
For some reason, coveralls says the coverage has decreased with this PR; however I don't really see how that's possible since I've only made changes to doc :) |
Yeah don't worry about that. It's not a perfect indicator. |
Trying to go for smaller PRs using branches... :)
Doesn't look like it worked though :/
See DOC-458