Skip to content

Commit

Permalink
chore(docs): update formattedVariables example (#800)
Browse files Browse the repository at this point in the history
fixes #764 

The example documentation for the formattedVariables helper is out of date, causing confusion. This change updates the example to a compatible syntax.
  • Loading branch information
joerobot authored Mar 29, 2022
1 parent cd0e8f7 commit c4b2304
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion lib/common/formatHelpers/formattedVariables.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,11 @@ const defaultFormatting = {
* StyleDictionary.registerFormat({
* name: 'myCustomFormat',
* formatter: function({ dictionary, options }) {
* return formattedVariables('less', dictionary, options.outputReferences);
* return formattedVariables({
* format: 'less',
* dictionary,
* outputReferences: options.outputReferences
* });
* }
* });
* ```
Expand Down

0 comments on commit c4b2304

Please sign in to comment.