Use `@default` instead of `@example` in docs
See: https://github.com/zurb/foundation-sites/issues/9464 Problem: `@example` values are presented as default in the documentation, and there is no way to get the default value automatically. Plus, the "example" value is often not relevant at all. > The reference section at the bottom is mostly meant to be a reference > —key plugin options should be documented in the main body of the > documentation, where there's more room to elaborate on things. > -- @gakimball Fix: - Use `@default` instead of `@example` - Make values in comment equal to the options default values Warning: This require to update the value used to generate Js reference in foundation-docs. Replaced values: Tooltip: - `templateClasses`: `'my-cool-tip-class'` replaced to `''` - `template`: `'<div class="tooltip"></div>'` replaced to `''` - `tip` text: `'Some cool space fact here.'` replaced to `''` - `positionClass`: `'top'` replaced to `''` Sticky: - `container`: `'<div data-sticky-container class="small-6 columns"></div>'` replaced to `'<div data-sticky-container></div>'` - `anchor`: `'exampleId'` replaced to `''` - `topAnchor`: `'exampleId:top'` replaced to `''` - `btmAchor`: `'exampleId:bottom'` replaced to `''` - `checkEvery`: `50` replaced to `-1` Reveal: - `animationIn`: `'slide-in-left'` replaced to `''` - `animationOut`: `'slide-in-left'` replaced to `''` - `showDelay`: `10` replaced to `0` - `hideDelay`: `10` replaced to `0` - `appendTo`: `false` replaced to `"body"` Offcanvas: - `transitionTime`: `500` replaced to `0` - `forceTo`: `top` replaced to `null` - `revealOn`: `reveal-for-large` replaced to `null` - `revealClass`: `reveal-for` replaced to `reveal-for-` - `trapFocus`: `false` replaced to `false` Magelian: - `animationEasing`: `'ease-in-out'` replaced to `linear` - `deepLinking`: `true` replaced to `false` - `barOffset`: `25` replaced to `0` Equalizer: - `equalizeOnStack`: `true` replaced to `false` - `equalizeOn`: `'medium'` replaced to `''` Dropdown: - `parentClass`: `'dropdown-parent'` replaced to `null` - `hoverPane`: `true` replaced to `false` - `positionClass`: `'top'` replaced by `''` - `autoFocus`: `true` replaced by `false` Drilldrow: - `backButton`: `'<\li><\a>Back<\/a><\/li>'` replaced by `'<li class="js-drilldown-back"><a tabindex="0">Back</a></li>' - `backButtonPosition`: `bottom` replaced by `top` - `wrapper`: `<\div class="is-drilldown"><\/div>` replaced by `'<div></div>'` - `scrollTopOffset`: `100` replaced by `0
Loading
Please sign in to comment