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

Jump to bottom

Module-ify built-in function documentation #366

Merged

nex3 merged 5 commits into feature.use from built-in-modules

Sep 5, 2019

Contributor

nex3 commented Sep 4, 2019

Closes #363

nex3 added 2 commits

September 4, 2019 15:24


          Rename /documentation/functions to /documentation/modules

This hierarchy is now going to document built-in modules, which mostly
contain functions but can also contain mixins and may potentially
contain variables in the future.


          Move plain-CSS function documentation into at-rules/function

df428f6

This isn't ideal, since these functions aren't defined with @function,
but there's not really a better place to put it. It certainly doesn't
make sense in the built-in module documentation anymore.

nex3 requested a review from jelbourn

September 4, 2019 22:24

houndci-bot reviewed

View reviewed changes

source/assets/js/components/redirect.js

+                  };
+                  var redirect = redirects[window.location.hash];
+                  if (redirect) window.location.href = redirect;

houndci-bot Sep 4, 2019

Expected '{' and instead saw 'window'.

source/assets/js/components/redirect.js

+                    "#unit-instance_method": "/documentation/modules/math#unit",
+                    "#unitless-instance_method": "/documentation/modules/math#is-unitless",
+                    "#unquote-instance_method": "/documentation/modules/string#unquote",
+                    "#variable_exists-instance_method": "/documentation/modules/meta#variable-exists",

houndci-bot Sep 4, 2019

Line is too long.

source/assets/js/components/redirect.js

+                    "#str_slice-instance_method": "/documentation/modules/string#slice",
+                    "#to_lower_case-instance_method": "/documentation/modules/string#to-lower-case",
+                    "#to_upper_case-instance_method": "/documentation/modules/string#to-upper-case",
+                    "#transparentize-instance_method": "/documentation/modules/color#transparentize",

houndci-bot Sep 4, 2019

Line is too long.

source/assets/js/components/redirect.js

+                    "#str_length-instance_method": "/documentation/modules/string#length",
+                    "#str_slice-instance_method": "/documentation/modules/string#slice",
+                    "#to_lower_case-instance_method": "/documentation/modules/string#to-lower-case",
+                    "#to_upper_case-instance_method": "/documentation/modules/string#to-upper-case",

houndci-bot Sep 4, 2019

Line is too long.

source/assets/js/components/redirect.js

+                    "#str_insert-instance_method": "/documentation/modules/string#insert",
+                    "#str_length-instance_method": "/documentation/modules/string#length",
+                    "#str_slice-instance_method": "/documentation/modules/string#slice",
+                    "#to_lower_case-instance_method": "/documentation/modules/string#to-lower-case",

houndci-bot Sep 4, 2019

Line is too long.

source/assets/js/components/redirect.js

+                    "#max-instance_method": "/documentation/modules/math#max",
+                    "#min-instance_method": "/documentation/modules/math#min",
+                    "#mix-instance_method": "/documentation/modules/color#mix",
+                    "#mixin_exists-instance_method": "/documentation/modules/meta#mixin-exists",

houndci-bot Sep 4, 2019

Line is too long.

source/assets/js/components/redirect.js

+                    "#length-instance_method": "/documentation/modules/list#length",
+                    "#lighten-instance_method": "/documentation/modules/color#lighten",
+                    "#lightness-instance_method": "/documentation/modules/color#lightness",
+                    "#list_separator-instance_method": "/documentation/modules/list#separator",

houndci-bot Sep 4, 2019

Line is too long.

source/assets/js/components/redirect.js

+                    "#inspect-instance_method": "/documentation/modules/meta#inspect",
+                    "#invert-instance_method": "/documentation/modules/color#invert",
+                    "#is_bracketed-instance_method": "/documentation/modules/list#is-bracketed",
+                    "#is_superselector-instance_method": "/documentation/modules/selector#is-superselector",

houndci-bot Sep 4, 2019

Line is too long.

source/assets/js/components/redirect.js

+                    "#index-instance_method": "/documentation/modules/list#index",
+                    "#inspect-instance_method": "/documentation/modules/meta#inspect",
+                    "#invert-instance_method": "/documentation/modules/color#invert",
+                    "#is_bracketed-instance_method": "/documentation/modules/list#is-bracketed",

houndci-bot Sep 4, 2019

Line is too long.

source/assets/js/components/redirect.js

+                    "#feature_exists-instance_method": "/documentation/modules/meta#feature-exists",
+                    "#floor-instance_method": "/documentation/modules/math#floor",
+                    "#get_function-instance_method": "/documentation/modules/meta#get-function",
+                    "#global_variable_exists-instance_method": "/documentation/modules/meta#global-variable-exists",

houndci-bot Sep 4, 2019

Line is too long.

nex3 had a problem deploying to sass-lang-pr-366

September 4, 2019 22:25

Failure

nex3 force-pushed the built-in-modules branch from 586cb2e to cd10213 Compare

September 5, 2019 00:49

nex3 had a problem deploying to sass-lang-pr-366

September 5, 2019 00:49

Failure

houndci-bot reviewed

View reviewed changes

source/assets/js/components/redirect.js

+                    "#desaturate-instance_method": "/documentation/modules/color#desaturate",
+                    "#feature_exists-instance_method": "/documentation/modules/meta#feature-exists",
+                    "#floor-instance_method": "/documentation/modules/math#floor",
+                    "#get_function-instance_method": "/documentation/modules/meta#get-function",

houndci-bot Sep 5, 2019

Line is too long.

source/assets/js/components/redirect.js

+                    "#content_exists-instance_method": "/documentation/modules/meta#content-exists",
+                    "#darken-instance_method": "/documentation/modules/color#darken",
+                    "#desaturate-instance_method": "/documentation/modules/color#desaturate",
+                    "#feature_exists-instance_method": "/documentation/modules/meta#feature-exists",

houndci-bot Sep 5, 2019

Line is too long.

source/assets/js/components/redirect.js

+                    "#change_color-instance_method": "/documentation/modules/color#change",
+                    "#comparable-instance_method": "/documentation/modules/math#compatible",
+                    "#complement-instance_method": "/documentation/modules/color#complement",
+                    "#content_exists-instance_method": "/documentation/modules/meta#content-exists",

houndci-bot Sep 5, 2019

Line is too long.

helpers/sass_helpers.rb

@@ @@ -490,7 +491,7 @@ def return_type_link(return_type) @@
                     when 'boolean'; link_to type, '/documentation/values/booleans'
                     when 'null'; link_to '<code>null</code>', '/documentation/values/null'
                     when 'function'; link_to type, '/documentation/values/functions'
-                    when 'selector'; link_to type, '/documentation/functions/selector#selector-values'
+                    when 'selector'; link_to type, '/documentation/modules/selector#selector-values'

houndci-bot Sep 5, 2019

Style/StringLiterals: Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.
Metrics/LineLength: Line is too long. [86/80]

helpers/sass_helpers.rb

    
                      name_element = signature_elements.find {|el| el.text == name}

                    unless names.include?(name_without_namespace)

                      names << name_without_namespace

                      name_element = signature_elements.find {|el| el.text == name_without_namespace}

houndci-bot Sep 5, 2019

Style/CollectionMethods: Prefer detect over find.
Layout/SpaceInsideBlockBraces: Space between { and | missing.
Metrics/LineLength: Line is too long. [87/80]
Layout/SpaceInsideBlockBraces: Space missing inside }.

helpers/sass_helpers.rb

@@ @@ -434,7 +434,8 @@ def _impl_status_row(name, status) @@
                 def function(*signatures, returns: nil)
                   names = Set.new
                   highlighted_signatures = signatures.map do |signature|
-                    name = signature.split("(").first
+                    name, rest = signature.split("(", 2)

houndci-bot Sep 5, 2019

Lint/UselessAssignment: Useless assignment to variable - rest. Use _ or _rest as a variable name to indicate that it won't be used.


          Module-ify built-in function documentation

b1b0754

Closes #363

nex3 force-pushed the built-in-modules branch from cd10213 to b1b0754 Compare

September 5, 2019 00:56

nex3 temporarily deployed to sass-lang-pr-366

September 5, 2019 00:56

Inactive

jelbourn reviewed

View reviewed changes

Member

jelbourn left a comment

Got about halfway through, will look at the rest tomorrow

source/documentation/at-rules/function.html.md.erb


		### Plain CSS Functions

		Any function call that's not either a user-defined or [built-in](../modules)

Member

jelbourn Sep 5, 2019

What do you think of rewording this into two sentence:

Sass evaluates user-defined and build-in functions during compilation.
All other functions compile to plain CSS functions unless they use the Sass
argument syntax.

Contributor Author

nex3 Sep 5, 2019

I think that's a bit confusing... "evaluates" is being used there to mean "invokes code defined for that function", but we use it elsewhere to mean more generally evaluating an expression, which does happen for plain CSS functions. It's just that the result of that evaluation is an unquoted string.

source/documentation/at-rules/function.html.md.erb Outdated Show resolved Hide resolved

source/documentation/at-rules/mixin.html.md.erb Outdated Show resolved Hide resolved

source/documentation/modules.html.md.erb Outdated Show resolved Hide resolved

source/documentation/modules.html.md.erb Outdated Show resolved Hide resolved

jelbourn reviewed

View reviewed changes

Member

jelbourn left a comment

LGTM for the rest; I didn't read all the function/module docs, assuming they're pretty much the same as before.

nex3 added 2 commits

September 5, 2019 14:39


          Code review changes

576474c


          Fix broken links

d46c2c7

nex3 deployed to sass-lang-pr-366

September 5, 2019 21:47

View deployment

nex3 merged commit ab7d3ec into feature.use

nex3 deleted the built-in-modules branch

September 5, 2019 21:54

asaf400 pushed a commit to asaf400/ass-site that referenced this pull request


          Merge pull request sass#366 from sass/built-in-modules

d1af7a4

Module-ify built-in function documentation

asaf400 pushed a commit to asaf400/ass-site that referenced this pull request


          Merge pull request sass#366 from sass/built-in-modules

f2e95f3

Module-ify built-in function documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet