Skip to content
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.

Sign up for GitHub

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

Update docstring for normalize_expression #461

Merged
merged 1 commit into from
Jan 31, 2021
Merged

Update docstring for normalize_expression #461

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions lib/utils/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,11 @@ function textStyle(layer) {
}

/**
* Normalize an offset value
* @param {String} expression a decimal value which may have a 'p' or '%' postfix. E.g. '35%', '0.4p'
* @return {Object|String} a normalized String of the input value if possible otherwise the value itself
* Normalize an expression string, replace "nice names" with their coded values and spaces with "_"
* e.g. `width > 0` => `w_lt_0`
*
* @param {String} expression An expression to be normalized
* @return {Object|String} A normalized String of the input value if possible otherwise the value itself
*/
function normalize_expression(expression) {
if (!isString(expression) || expression.length === 0 || expression.match(/^!.+!$/)) {
Expand Down