search

sveltejs / svelte-preprocess

A ✨ magical ✨ Svelte preprocessor with sensible defaults and support for: PostCSS, SCSS, Less, Stylus, Coffeescript, TypeScript, Pug and much more.
MIT License
1.73k stars 147 forks source link

Doc out of date: Sass renderSync option no longer does anything #563

Closed alecglassford closed 1 year ago

alecglassford commented 1 year ago

Describe the bug

This bit of documentation is out of date: https://github.com/sveltejs/svelte-preprocess/blob/4218419a145c29248d682cddc3eda557409ec38b/docs/preprocessing.md?plain=true#L356

Following https://github.com/sveltejs/svelte-preprocess/commit/06fd5b9af92c985cbf1e7a89e5d576102b66786b it seems like svelte-preprocess can only use Sass's renderSync API, so the option no longer has an effect.

This part of the doc might cause users to think (incorrectly) that they are using Sass's render API unless they specify the option.

Logs N/A

To Reproduce Read https://github.com/sveltejs/svelte-preprocess/blob/4218419a145c29248d682cddc3eda557409ec38b/docs/preprocessing.md#scss-sass

Expected behavior Behavior described by doc matches behavior of code.

Stacktraces N/A

Information about your project: N/A

Additional context N/A