Skip to content

docs: fix typo - #1474

Merged
Nelson-numerical-software merged 1 commit into
masterfrom
fix-typo
Oct 30, 2025
Merged

Nelson-numerical-software merged 1 commit into
masterfrom
fix-typo

Conversation

@Nelson-numerical-software

Copy link
Copy Markdown
Collaborator

No description provided.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request enhances documentation clarity by fixing spelling errors, adding mathematical definitions, improving code formatting, and moving author information to HTML comments to keep source attribution without visible rendering.

  • Fixed spelling errors ("singal" → "signal", "audiorwrite" → "audiowrite")
  • Added comprehensive mathematical definition with LaTeX formulas for the incomplete beta function in French documentation
  • Modified XSLT templates to emit author information as HTML comments instead of visible sections

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
modules/special_functions/help/fr_FR/xml/betainc.xml Enhanced documentation with detailed mathematical definition and LaTeX formulas for the incomplete beta function
modules/help_tools/resources/nelson_markdown.xslt Updated to wrap author section in HTML comments for Markdown output
modules/help_tools/resources/nelson_html.xslt Modified to emit author information as HTML comments instead of visible div elements
modules/help_tools/help/fr_FR/xml/1_nelson_help_reference.xml Improved line formatting by splitting long line for better readability
modules/help_tools/help/en_US/xml/1_nelson_help_reference.xml Split multiple long lines across multiple lines for better readability
modules/audio/help/en_US/xml/lin2mu.xml Fixed spelling: "singal" → "signal"
modules/audio/help/en_US/xml/audiowrite.xml Fixed spelling errors: "audiorwrite" → "audiowrite" and "More 26" → "More than 26"
CHANGELOG-0.6.x.md Fixed spelling: "singal" → "signal"

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

<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.
Comment on lines +255 to +257
<xsl:if test="position() != last()">
<xsl:text>&#10;</xsl:text>
</xsl:if>

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.
@Nelson-numerical-software
Nelson-numerical-software merged commit e33817b into master Oct 30, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants