update sourceComments documentation in README.md #1820
Conversation
expand on sourceComments description in README.md
| @@ -351,7 +351,8 @@ var result = sass.renderSync({ | |||
| data: 'body{background:blue; a{color:black;}}', | |||
| outputStyle: 'compressed', | |||
| outFile: '/to/my/output.css', | |||
| sourceMap: true, // or an absolute or relative (to outFile) path | |||
| sourceMap: true, // or an absolute or relative (to outFile) path, | |||
| sourceComments: true, | |||
There was a problem hiding this comment.
Not needed since the Sass project doesn't recommend using this option anymore (AFIK)
| @@ -257,7 +257,7 @@ Used to determine how many digits after the decimal will be allowed. For instanc | |||
| Type: `Boolean` | |||
| Default: `false` | |||
|
|
|||
| `true` enables additional debugging information in the output file as CSS comments | |||
| `true` enables additional debugging information (line number and source scss file reference, similar to :line_comments in compass) in the output file as CSS comments | |||
There was a problem hiding this comment.
:line_numbers is the Ruby Sass one (with :line_comments as an alias) http://sass-lang.com/documentation/file.SASS_REFERENCE.html#options
Compass is depreciated now, so probably shouldn't be mentioned
There was a problem hiding this comment.
Yes please remove the reference to compass.
| @@ -257,7 +257,7 @@ Used to determine how many digits after the decimal will be allowed. For instanc | |||
| Type: `Boolean` | |||
| Default: `false` | |||
|
|
|||
| `true` enables additional debugging information in the output file as CSS comments | |||
| `true` enables additional debugging information (line number and source scss file reference, similar to :line_comments in compass) in the output file as CSS comments | |||
There was a problem hiding this comment.
Yes please remove the reference to compass.
updated doc (removed reference to compass) per code review recommendations
edits to sourceComments doc in README.md
| @@ -351,7 +351,7 @@ var result = sass.renderSync({ | |||
| data: 'body{background:blue; a{color:black;}}', | |||
| outputStyle: 'compressed', | |||
| outFile: '/to/my/output.css', | |||
| sourceMap: true, // or an absolute or relative (to outFile) path | |||
| sourceMap: true, // or an absolute or relative (to outFile) path, | |||
There was a problem hiding this comment.
Please remove the comma at the end of the comment
|
Thank you @screamingmunch! ❤️ |
|
Apologies to all the rookie misses.. first-time contributing to open source. Removed references to compass, and removed the comma in code sample(left by previous author). =) |
|
No worries @screamingmunch, we're excited you have your help! |
selector-unify should return null instead of an empty list
expand on sourceComments description in README.md