Skip to content

docs: fix typo #1474

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Nelson-numerical-software merged 1 commit into from
Oct 30, 2025
Merged

docs: fix typo #1474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG-0.6.x.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ Implemented features:
- `sound`: Convert matrix of signal data to sound and play it.
- `soundsc`: Scale data and play as sound.
- `mu2lin`: Convert audio data from mu-law to linear signal.
- `lin2mu`: Convert audio data from linear singal to mu-law.
- `lin2mu`: Convert audio data from linear signal to mu-law.

- elementary functions module:

Expand Down
4 changes: 2 additions & 2 deletions modules/audio/help/en_US/xml/audiowrite.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@
</param_input>
<description>
<p>
<b>audiorwrite</b> writes an audio file.</p>
<p>More 26 files format supported. See <b
<b>audiowrite</b> writes an audio file.</p>
<p>More than 26 files format supported. See <b
>audiosupportedformats</b> function to have all supported formats.</p>
</description>
<used_function />
Expand Down
2 changes: 1 addition & 1 deletion modules/audio/help/en_US/xml/lin2mu.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<language>en_US</language>
<keyword>lin2mu</keyword>
<short_description
>Convert audio data from linear singal to mu-law.</short_description>
>Convert audio data from linear signal to mu-law.</short_description>
<syntax>
<syntax_item>mu = lin2mu(y)</syntax_item>
</syntax>
Expand Down
15 changes: 10 additions & 5 deletions modules/help_tools/help/en_US/xml/1_nelson_help_reference.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,23 +89,28 @@
<li><b>`&lt;b&gt;`</b> — bold text.</li>
<li><b>`&lt;i&gt;`</b> — italic text.</li>
<li><b>`&lt;code&gt;`</b> — inline code rendering.</li>
<li><b>`&lt;a href="..."&gt;`</b> — external links (rendered as HTML anchors).</li>
<li><b>`&lt;link linkend="..."&gt;`</b> — internal cross reference. If linkend contains a module in braces <code
<li><b
>`&lt;a href="..."&gt;`</b> — external links (rendered as HTML anchors).</li>
<li><b
>`&lt;link linkend="..."&gt;`</b> — internal cross reference. If linkend contains a module in braces <code
>{module}name</code> it becomes <code
>../module/name.html</code>, otherwise <code>name.html</code>.</li>
<li><b>`&lt;latex&gt;`</b> — math expressions; rendered as MathJax display math by the XSLT template (wrapped with <code
<li><b
>`&lt;latex&gt;`</b> — math expressions; rendered as MathJax display math by the XSLT template (wrapped with <code
>`$$...$$`</code>).</li>
<li><b>`&lt;img src="..."/&gt;`</b> — images. XSLT calls <code
>ext:copy_img(@src)</code>; SVGs are rendered with a large fixed frame and other formats are responsive.</li>
</ul>

<p>Block elements:</p>
<ul>
<li><code>`&lt;ul&gt;`</code> and <code>`&lt;ol&gt;`</code> — lists. Use <code
<li><code>`&lt;ul&gt;`</code> and <code
>`&lt;ol&gt;`</code> — lists. Use <code
>`&lt;li&gt;`</code> with nested inline/block markup as needed.</li>
<li><code>`&lt;table&gt;`</code> — use <code>`&lt;thead&gt;`</code>, <code
>`&lt;tbody&gt;`</code>, <code>`&lt;tr&gt;`</code>, <code
>`&lt;th&gt;`</code> and <code>`&lt;td&gt;`</code>. The XSD allows common attributes <code
>`&lt;th&gt;`</code> and <code
>`&lt;td&gt;`</code>. The XSD allows common attributes <code
>border</code>, <code>cellpadding</code> and <code
>cellspacing</code>.</li>
</ul>
Expand Down
3 changes: 2 additions & 1 deletion modules/help_tools/help/fr_FR/xml/1_nelson_help_reference.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@
>`&lt;table&gt;`</code>), des balisages en ligne (<code
>`&lt;b&gt;`</code>, <code>`&lt;i&gt;`</code>, <code
>`&lt;code&gt;`</code>), des images (<code
>`&lt;img src="..."/&gt;`</code>) et LaTeX (<code>`&lt;latex&gt;`</code>).</p>
>`&lt;img src="..."/&gt;`</code>) et LaTeX (<code
>`&lt;latex&gt;`</code>).</p>

<p>Les éléments en ligne et leur rendu XSLT :</p>
<ul>
Expand Down
23 changes: 12 additions & 11 deletions modules/help_tools/resources/nelson_html.xslt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,20 +76,21 @@
</a>
<xsl:apply-templates select="xmldoc"/>

<!-- Author section always LAST -->
<!-- Author section: emit as HTML comment (keeps info in source but not visible) -->
<xsl:if test="xmldoc/authors/author_item">
<div class="section" style="margin-top:30px;">
<div class="section-title"><span class="syntax-icon">👤</span> <xsl:choose>
<xsl:comment>
<xsl:choose>
<xsl:when test="xmldoc/language = 'fr_FR'">Auteur</xsl:when>
<xsl:otherwise>Author</xsl:otherwise>
</xsl:choose><xsl:if test="count(xmldoc/authors/author_item) &gt; 1">s</xsl:if></div>
<div>
<xsl:for-each select="xmldoc/authors/author_item">
<xsl:value-of select="."/>
<xsl:if test="position() != last()">, </xsl:if>
</xsl:for-each>
</div>
</div>
</xsl:choose>
<xsl:text>: </xsl:text>
<xsl:for-each select="xmldoc/authors/author_item">
<xsl:value-of select="."/>
<xsl:if test="position() != last()">
<xsl:text>, </xsl:text>
</xsl:if>
</xsl:for-each>
</xsl:comment>
</xsl:if>

<!-- GitHub Edit Button: placed as the last element on the page -->
Expand Down
19 changes: 13 additions & 6 deletions modules/help_tools/resources/nelson_markdown.xslt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,13 +243,20 @@
</xsl:for-each>
</xsl:if>

<!-- Only show author section if there are authors -->
<!-- Only show author section if there are authors
-> Emit authors inside an HTML comment so they appear in the generated file
but are not rendered in the Markdown output.
-> Keep localization by using $author-text.
-->
<xsl:if test="authors/author_item">
<xsl:text>&#10;## </xsl:text><xsl:value-of select="$author-text"/><xsl:text>&#10;&#10;</xsl:text>
<xsl:for-each select="authors/author_item">
<xsl:value-of select="."/>
<xsl:text>&#10;</xsl:text>
</xsl:for-each>
<xsl:text>&#10;&lt;!--&#10;## </xsl:text><xsl:value-of select="$author-text"/><xsl:text>&#10;&#10;</xsl:text>
<xsl:for-each select="authors/author_item">
<xsl:value-of select="."/>
<xsl:if test="position() != last()">
<xsl:text>&#10;</xsl:text>
</xsl:if>
Comment on lines +255 to +257

Copilot AI Oct 29, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This conditional newline logic creates inconsistent spacing. The last author won't have a trailing newline before the closing comment delimiter, while all others will. This could lead to unexpected formatting in the generated markdown. Consider adding a newline after the loop completes or removing the condition to ensure consistent spacing.

Suggested change
<xsl:if test="position() != last()">
<xsl:text>&#10;</xsl:text>
</xsl:if>
<xsl:text>&#10;</xsl:text>

Copilot uses AI. Check for mistakes.
</xsl:for-each>
<xsl:text>&#10;--&gt;&#10;</xsl:text>
</xsl:if>
</xsl:template>

Expand Down
15 changes: 13 additions & 2 deletions modules/special_functions/help/fr_FR/xml/betainc.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,20 @@
</param_output>
<description>
<p>
<b>betainc</b> calcule la fonction bêta incomplète.</p>
<p
<b>betainc</b> calcule la fonction bêta incomplète (régularisée).
</p>
<p>La fonction bêta incomplète est définie comme suit :</p>
<latex
>I_x(a,b) = \frac{B(x; a,b)}{B(a,b)} = \frac{1}{B(a,b)} \int_0^x t^{a-1} (1-t)^{b-1} \, dt</latex>
<p>où</p>
<latex>B(a,b) = \int_0^1 t^{a-1} (1-t)^{b-1} \, dt</latex>
<p>est la fonction bêta complète, et :</p>
<latex>B(a,b) = \frac{\Gamma(a)\Gamma(b)}{\Gamma(a+b)}</latex>
<p>La fonction est normalisée de sorte que</p>
<latex>I_1(a,b) = 1</latex>.

Copilot AI Oct 29, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The period (.) should be placed outside the <latex> tag. The mathematical expression should end within the tag, and the sentence punctuation should follow in the text, consistent with standard documentation formatting.

Copilot uses AI. Check for mistakes.
<p
>Tous les tableaux doivent avoir la même taille ou n'importe lequel d'entre eux peut être scalaire.</p>

</description>
<used_function />
<bibliography />
Expand Down