DOC-2 Document how to normalize facet values #448
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
DOC-690 - Document the usage of Coveo.options
(these two documentation issues were somehow related)
- Added link to the **Normalizing Facet Value Captions** article in `Facet.options.valueCaption`
- Changed the note that misleadingly said some options could only be set in the `init` call, added relevant links, and modified examples for:
- `Facet.options.valueCaption`
- `FacetSlider.options.getSteps`
- `FacetSlider.options.valueCaption`
- `FieldSuggestions.options.onSelect`
- `ResultLink.options.onClick`
- `ResultsFiltersPreferences.options.filters`
- Made mostly cosmetic changes to the `Facet`, `FacetSlider`, `FieldSuggestions`, `ResultLink`, and `ResultsFiltersPreferences` documentation.
fbeaudoincoveo
commented
May 5, 2017
| * Note that this component does not inherit from the Facet component, and thus does not offer the same configuration | ||
| * options. Also, some of the FacetSlider options cannot be set as a HTML attributes on the component and must rather be | ||
| * configured in the {@link init} call of the search interface. | ||
| * |
There was a problem hiding this comment.
I removed the following examples, because I feel the Passing Component Options in the init Call / Passing Component Options Before the init Call topics explain this pretty well, and the links are repeated in the options which can't be configured through the markup.
|
Sorry about the huge PR... |
DOC-690 - Document the usage of Coveo.options - Fixed error in TypeDoc.
olamothe
approved these changes
May 8, 2017
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.
DOC-690 - Document the usage of Coveo.options
(these two documentation issues were somehow related)
Added link to the Normalizing Facet Value Captions article in
Facet.options.valueCaptionChanged the note that misleadingly said some options could only be set in the
initcall, added relevant links, and modified examples for:Facet.options.valueCaptionFacetSlider.options.getStepsFacetSlider.options.valueCaptionFieldSuggestions.options.onSelectResultLink.options.onClickResultsFiltersPreferences.options.filtersMade mostly cosmetic changes to the
Facet,FacetSlider,FieldSuggestions,ResultLink, andResultsFiltersPreferencesdocumentation.