Skip to content

Commit dab882a

Browse files
update help
1 parent 5e5c4ef commit dab882a

File tree

5,965 files changed

+39109
-44919
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

5,965 files changed

+39109
-44919
lines changed

docs/releases/en_US/latest/assert_functions/assert.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,11 @@
7171
<div class="section-title">
7272
<span class="syntax-icon">📄</span>Description</div>
7373
<div>
74-
<p><b>assert</b> raises an error if the input value is false.</p>
75-
<p>This function also raises an error if the input is not a logical value, ensuring type safety.</p>
76-
<p>When the optional <b>err_msg</b> parameter is provided, it will be used as the error message instead of the default message when the assertion fails.</p>
77-
<p>This is the fundamental assertion function that forms the basis for testing conditions in programs and unit tests.</p>
78-
</div>
74+
<p><b>assert</b> raises an error if the input value is false.</p>
75+
<p>This function also raises an error if the input is not a logical value, ensuring type safety.</p>
76+
<p>When the optional<b>err_msg</b> parameter is provided, it will be used as the error message instead of the default message when the assertion fails.</p>
77+
<p>This is the fundamental assertion function that forms the basis for testing conditions in programs and unit tests.</p>
78+
</div>
7979
</div>
8080
<div class="section">
8181
<div class="section-title">

docs/releases/en_US/latest/assert_functions/assert_checkerror.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,11 @@
7575
<div class="section-title">
7676
<span class="syntax-icon">📄</span>Description</div>
7777
<div>
78-
<p><b>assert_checkerror</b> verifies that executing a command raises the expected error message.</p>
79-
<p>If the command does not raise any error, or if it raises an error with a different message than expected, the assertion fails.</p>
80-
<p>When the optional <b>expected_error_identifier</b> parameter is provided, the function also checks that the error identifier matches the expected one.</p>
81-
<p>This function is particularly useful for unit testing to ensure that invalid inputs or operations properly generate the expected error conditions.</p>
82-
</div>
78+
<p><b>assert_checkerror</b> verifies that executing a command raises the expected error message.</p>
79+
<p>If the command does not raise any error, or if it raises an error with a different message than expected, the assertion fails.</p>
80+
<p>When the optional<b>expected_error_identifier</b> parameter is provided, the function also checks that the error identifier matches the expected one.</p>
81+
<p>This function is particularly useful for unit testing to ensure that invalid inputs or operations properly generate the expected error conditions.</p>
82+
</div>
8383
</div>
8484
<div class="section">
8585
<div class="section-title">

docs/releases/en_US/latest/assert_functions/assert_isapprox.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,11 @@
7575
<div class="section-title">
7676
<span class="syntax-icon">📄</span>Description</div>
7777
<div>
78-
<p><b>assert_isapprox</b> raises an error if the computed value is not approximately equal to the expected value.</p>
79-
<p>This function compares two floating point numbers with a specified tolerance, allowing you to check that two numbers are "approximately" equal when exact equality is not suitable due to floating-point precision limitations.</p>
80-
<p>The comparison uses relative error calculation to determine if the values are within the specified precision tolerance.</p>
81-
<p>This function is particularly useful in unit testing when dealing with numerical computations that may have small rounding errors.</p>
82-
</div>
78+
<p><b>assert_isapprox</b> raises an error if the computed value is not approximately equal to the expected value.</p>
79+
<p>This function compares two floating point numbers with a specified tolerance, allowing you to check that two numbers are "approximately" equal when exact equality is not suitable due to floating-point precision limitations.</p>
80+
<p>The comparison uses relative error calculation to determine if the values are within the specified precision tolerance.</p>
81+
<p>This function is particularly useful in unit testing when dealing with numerical computations that may have small rounding errors.</p>
82+
</div>
8383
</div>
8484
<div class="section">
8585
<div class="section-title">

docs/releases/en_US/latest/assert_functions/assert_isequal.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@
6868
<div class="section-title">
6969
<span class="syntax-icon">📄</span>Description</div>
7070
<div>
71-
<p><b>assert_isequal</b> raises an error if the computed value is not equal to the expected value.</p>
72-
<p>This function performs strict equality testing that checks for same type, same dimensions, and same values comparisons. It uses the same logic as the <b>isequaln</b> function.</p>
73-
<p>Unlike standard equality operators, this function properly handles NaN values, considering them equal when both values contain NaN in the same positions.</p>
74-
<p>This function is essential for unit testing to verify that computed results match expected outcomes exactly.</p>
75-
</div>
71+
<p><b>assert_isequal</b> raises an error if the computed value is not equal to the expected value.</p>
72+
<p>This function performs strict equality testing that checks for same type, same dimensions, and same values comparisons. It uses the same logic as the<b>isequaln</b> function.</p>
73+
<p>Unlike standard equality operators, this function properly handles NaN values, considering them equal when both values contain NaN in the same positions.</p>
74+
<p>This function is essential for unit testing to verify that computed results match expected outcomes exactly.</p>
75+
</div>
7676
</div>
7777
<div class="section">
7878
<div class="section-title">

docs/releases/en_US/latest/assert_functions/assert_isfalse.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,11 @@
7171
<div class="section-title">
7272
<span class="syntax-icon">📄</span>Description</div>
7373
<div>
74-
<p><b>assert_isfalse</b> raises an error if the input value is true.</p>
75-
<p>This function also raises an error if the input is not a logical value, ensuring type safety.</p>
76-
<p>When the optional <b>err_msg</b> parameter is provided, it will be used as the error message instead of the default message when the assertion fails.</p>
77-
<p>This function is useful in unit testing to verify that conditions are false or that logical operations return the expected false result.</p>
78-
</div>
74+
<p><b>assert_isfalse</b> raises an error if the input value is true.</p>
75+
<p>This function also raises an error if the input is not a logical value, ensuring type safety.</p>
76+
<p>When the optional<b>err_msg</b> parameter is provided, it will be used as the error message instead of the default message when the assertion fails.</p>
77+
<p>This function is useful in unit testing to verify that conditions are false or that logical operations return the expected false result.</p>
78+
</div>
7979
</div>
8080
<div class="section">
8181
<div class="section-title">

docs/releases/en_US/latest/assert_functions/assert_istrue.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,11 @@
7171
<div class="section-title">
7272
<span class="syntax-icon">📄</span>Description</div>
7373
<div>
74-
<p><b>assert_istrue</b> raises an error if the input value is false.</p>
75-
<p>This function also raises an error if the input is not a logical value, ensuring type safety.</p>
76-
<p>When the optional <b>err_msg</b> parameter is provided, it will be used as the error message instead of the default message when the assertion fails.</p>
77-
<p>This function is essential in unit testing to verify that conditions are true or that logical operations return the expected true result.</p>
78-
</div>
74+
<p><b>assert_istrue</b> raises an error if the input value is false.</p>
75+
<p>This function also raises an error if the input is not a logical value, ensuring type safety.</p>
76+
<p>When the optional<b>err_msg</b> parameter is provided, it will be used as the error message instead of the default message when the assertion fails.</p>
77+
<p>This function is essential in unit testing to verify that conditions are true or that logical operations return the expected true result.</p>
78+
</div>
7979
</div>
8080
<div class="section">
8181
<div class="section-title">

docs/releases/en_US/latest/assert_functions/help_toc_summary.xml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@
44
<module>assert_functions</module>
55
<section name="Assertion functions">
66
<chapter_description>
7-
<p>The Asserts Functions module in Nelson provides tools for validating program behavior and
8-
verifying conditions during development or testing.</p>
9-
<p>These functions help ensure that computations and logical conditions meet expected criteria,
10-
improving code reliability and catching errors early.</p>
11-
</chapter_description>
7+
<p>The Asserts Functions module in Nelson provides tools for validating program behavior and verifying conditions during development or testing.</p>
8+
<p>These functions help ensure that computations and logical conditions meet expected criteria, improving code reliability and catching errors early.</p>
9+
</chapter_description>
1210
<keyword name="assert" link="assert.html" description="Check that condition is true."/>
1311
<keyword name="assert_checkerror" link="assert_checkerror.html" description="Check that a command raises the expected error."/>
1412
<keyword name="assert_isapprox" link="assert_isapprox.html" description="Check that computed and expected values are approximately equal."/>

docs/releases/en_US/latest/assert_functions/index.html

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,9 @@
1818
<img src="banner_nelson_small.png" alt="Nelson banner" style="display:block;margin:16px auto;max-width:50%;height:auto;" onerror="this.style.display='none';"><a href="../summary.html" style="position:fixed;top:18px;right:18px;z-index:1000;text-decoration:none;"><button style="background:#1976d2;color:#fff;border:none;padding:8px 14px;font-size:1.3em;border-radius:50%;box-shadow:0 2px 8px rgba(0,0,0,0.07);cursor:pointer;transition:background 0.2s;display:flex;align-items:center;justify-content:center;width:44px;height:44px;"><svg xmlns="http://www.w3.org/2000/svg" width="22" height="22" viewBox="0 0 24 24" fill="none" stroke="white" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M3 12L12 3l9 9"></path><path d="M9 21V12h6v9"></path><path d="M9 21h6"></path></svg></button></a><div class="section">
1919
<div class="section-title">Assertion functions</div>
2020
<div class="chapter-desc" style="font-size:0.97em;margin-bottom:10px;margin-left:24px;">
21-
<p>The Asserts Functions module in Nelson provides tools for validating program behavior and
22-
verifying conditions during development or testing.</p>
23-
<p>These functions help ensure that computations and logical conditions meet expected criteria,
24-
improving code reliability and catching errors early.</p>
25-
</div>
21+
<p>The Asserts Functions module in Nelson provides tools for validating program behavior and verifying conditions during development or testing.</p>
22+
<p>These functions help ensure that computations and logical conditions meet expected criteria, improving code reliability and catching errors early.</p>
23+
</div>
2624
<ul class="toc-list">
2725
<li class="toc-entry">
2826
<a class="toc-link" href="assert.html" target="contentFrame">assert</a><div class="keyword-desc" style="font-size:0.92em; color:#888; margin-left:18px; margin-top:2px;">Check that condition is true.</div>

docs/releases/en_US/latest/audio/audiodevinfo.html

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,9 @@
9696
<div class="section-title">
9797
<span class="syntax-icon">📄</span>Description</div>
9898
<div>
99-
<p>
100-
<b>audiodevinfo</b> returns a structure with available audio input and output devices.</p>
101-
<p>
102-
<b>devices = audiodevinfo('default')</b> returns a structure with default used audio input and output devices.</p>
103-
</div>
99+
<p><b>audiodevinfo</b> returns a structure with available audio input and output devices.</p>
100+
<p><b>devices = audiodevinfo('default')</b> returns a structure with default used audio input and output devices.</p>
101+
</div>
104102
</div>
105103
<div class="section">
106104
<div class="section-title">

docs/releases/en_US/latest/audio/audioinfo.html

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,9 @@
5858
<div class="section-title">
5959
<span class="syntax-icon">📄</span>Description</div>
6060
<div>
61-
<p>
62-
<b>audioinfo</b> returns a structure with information about audio file.</p>
63-
<p>Many audio formats are supported as OGG, FLAC, WAV, RAW.</p>
64-
</div>
61+
<p><b>audioinfo</b> returns a structure with information about audio file.</p>
62+
<p>Many audio formats are supported as OGG, FLAC, WAV, RAW.</p>
63+
</div>
6564
</div>
6665
<div class="section">
6766
<div class="section-title">

0 commit comments

Comments
 (0)