Facet range doc review #303
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
fbeaudoincoveo
commented
Feb 2, 2017
| * $("#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.
Should I expose the constructor?
There was a problem hiding this comment.
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Trying to go for smaller PRs using branches... :)
Doesn't look like it worked though :/
See DOC-458