Cleanup compressors documentation.

compressors.lib

@@ -48,17 +48,16 @@ declare name "Faust Compressor Effect Library";
 declare version "1.6.0";
 
 //================================Conversion Tools=======================================
-// Useful conversion tools for compressors.
-//========================================================================================
-
-//--------------------`(co.)ratio2strength `-------------------
 // Most compressors have a ratio parameter to define the amount of compression.
-// A ratio of 1 means no compression, a ratio of 2 means that for every dB the input goes above the threshold,
-// the output gets turned down half a dB.
+// A ratio of 1 means no compression, a ratio of 2 means that for every dB the input 
+// goes above the threshold, the output gets turned down half a dB.
 // To use a compressor as a brick wall limiter, the ratio needs to be infinity.
-// This is hard to express in a faust UI element, and overcompression can not be expressed at all,
+// This is hard to express in a Faust UI element, and overcompression can not be expressed at all,
 // therefore most compressors in this library use a strength parameter instead, where
 // 0 means no compression, 1 means hard limiting and  bigger than 1 means over-compression.
+//========================================================================================
+//
+//--------------------`(co.)ratio2strength `-------------------
 //
 // This utility converts a ratio to a strength.
 //
@@ -79,13 +78,6 @@ declare ratio2strength license "GPLv3";
 ratio2strength(ratio) = 1-(1/ratio);
 
 //--------------------`(co.)strength2ratio `-------------------
-// Most compressors have a ratio parameter to define the amount of compression.
-// A ratio of 1 means no compression, a ratio of 2 means that for every dB the input goes above the threshold,
-// the output gets turned down half a dB.
-// To use a compressor as a brick wall limiter, the ratio needs to be infinity.
-// This is hard to express in a faust UI element, and overcompression can not be expressed at all,
-// therefore most compressors in this library use a strength parameter instead, where
-// 0 means no compression, 1 means hard limiting and bigger than 1 means over-compression.
 //
 // This utility converts a strength to a ratio.
 //

docs/index.html

@@ -384,5 +384,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.5.3
-Build Date UTC : 2024-11-14 21:08:09.390545+00:00
+Build Date UTC : 2024-11-15 21:03:27.510643+00:00
 -->

docs/libs/compressors/index.html

@@ -377,16 +377,15 @@ <h4 id="references">References</h4>
 <li><a href="https://github.com/grame-cncm/faustlibraries/blob/master/compressors.lib">https://github.com/grame-cncm/faustlibraries/blob/master/compressors.lib</a></li>
 </ul>
 <h2 id="conversion-tools">Conversion Tools</h2>
-<p>Useful conversion tools for compressors.</p>
-<hr />
-<h3 id="coratio2strength"><code>(co.)ratio2strength</code></h3>
 <p>Most compressors have a ratio parameter to define the amount of compression.
-A ratio of 1 means no compression, a ratio of 2 means that for every dB the input goes above the threshold,
-the output gets turned down half a dB.
+A ratio of 1 means no compression, a ratio of 2 means that for every dB the input 
+goes above the threshold, the output gets turned down half a dB.
 To use a compressor as a brick wall limiter, the ratio needs to be infinity.
-This is hard to express in a faust UI element, and overcompression can not be expressed at all,
+This is hard to express in a Faust UI element, and overcompression can not be expressed at all,
 therefore most compressors in this library use a strength parameter instead, where
 0 means no compression, 1 means hard limiting and  bigger than 1 means over-compression.</p>
+<hr />
+<h3 id="coratio2strength"><code>(co.)ratio2strength</code></h3>
 <p>This utility converts a ratio to a strength.</p>
 <h4 id="usage">Usage</h4>
 <pre><code>ratio2strength(ratio) : _
@@ -397,13 +396,6 @@ <h4 id="usage">Usage</h4>
 </ul>
 <hr />
 <h3 id="costrength2ratio"><code>(co.)strength2ratio</code></h3>
-<p>Most compressors have a ratio parameter to define the amount of compression.
-A ratio of 1 means no compression, a ratio of 2 means that for every dB the input goes above the threshold,
-the output gets turned down half a dB.
-To use a compressor as a brick wall limiter, the ratio needs to be infinity.
-This is hard to express in a faust UI element, and overcompression can not be expressed at all,
-therefore most compressors in this library use a strength parameter instead, where
-0 means no compression, 1 means hard limiting and bigger than 1 means over-compression.</p>
 <p>This utility converts a strength to a ratio.</p>
 <h4 id="usage_1">Usage</h4>
 <pre><code>strength2ratio(strength) : _