Sass documentation cleanup #125

Open

toastal wants to merge 1 commit from toastal/documentation:sass-stuff into main

toastal commented

2021-03-16 07:54:31 +00:00

First-time contributor

It's definitely Sass and not SASS, but I found it a little hard to understand the documentation as is. Sass is Sass; and it has two syntaxes, but they're both Sass.

It's definitely [Sass and not SASS](http://www.sassnotsass.com/), but I found it a little hard to understand the documentation as is. Sass is Sass; and it has two syntaxes, but they're both Sass.

Marius added the

enhancement

label 2021-03-16 08:31:17 +00:00

Marius commented

2021-03-16 09:07:52 +00:00

Contributor

In source/guide/instance-administration.html.md you add the following :

[a Sass syntax](https://sass-lang.com/documentation/syntax) (SCSS or indented)

What is the point to precise (SCSS or indented) ? As i do not know the real difference between them it confuses me a little.

In [source/guide/instance-administration.html.md](https://git.joinplu.me/Plume/documentation/src/commit/542a0b923660e897ff619f13e437162892c34be5/source/guide/instance-administration.html.md) you add the following : ```markdown [a Sass syntax](https://sass-lang.com/documentation/syntax) (SCSS or indented) ``` What is the point to precise *(SCSS or indented)* ? As i do not know the real difference between them it confuses me a little.

toastal commented

2021-03-16 15:10:16 +00:00

Author

First-time contributor

They are the same language, yes... SCSS (*.scss) has semicolons, braces, and isn't white space sensative. The indented synax (*.sass) was the original syntax, but is still supported and widely used; it is white space sensative (like Python, Ruby, Haskell, etc.) so it can skip the braces and semicolons, and the mixin, etc. syntax is a tad bit different. The should be able to import from one syntax to another (some libraries may have implemented the spec poorly). I felt the Plume documentation reads like they're different languages instead of coat of paint on the same shed. My intention for adding the paranthesis was to emphasize that both syntaxes are in fact supported.

They are the same language, yes... SCSS (`*.scss`) has semicolons, braces, and isn't white space sensative. The indented synax (`*.sass`) was the original syntax, but is still supported and widely used; it is white space sensative (like Python, Ruby, Haskell, etc.) so it can skip the braces and semicolons, and the mixin, etc. syntax is a tad bit different. The _should_ be able to import from one syntax to another (some libraries may have implemented the spec poorly). I felt the Plume documentation reads like they're different languages instead of coat of paint on the same shed. My intention for adding the paranthesis was to emphasize that _both_ syntaxes are in fact supported.

KitaitiMakoto commented

2021-03-27 10:25:24 +00:00

Owner

@toastal Thank you for a pull request. Using correct words as you offer is good. But phrases like (SCSS or indented) might cause some confusion as @Marius says. How about to just notice extensions such as: Sass (*.sass or *.scss)?

@toastal Thank you for a pull request. Using correct words as you offer is good. But phrases like *(SCSS or indented)* might cause some confusion as @Marius says. How about to just notice extensions such as: *Sass (`*.sass` or `*.scss`)*?

This pull request can be merged automatically.

This branch is out-of-date with the base branch

You are not authorized to merge this pull request.

View command line instructions