Skip to content

Fix typos in documentation comments#3

Draft
Copilot wants to merge 3 commits intodevelfrom
copilot/fix-typos-and-documentation
Draft

Fix typos in documentation comments#3
Copilot wants to merge 3 commits intodevelfrom
copilot/fix-typos-and-documentation

Conversation

Copy link
Copy Markdown

Copilot AI commented Dec 10, 2025

Corrects spelling errors and incomplete documentation in header files identified during code review.

Fixed typos:

  • consantconstant in NumberStatistics.h and TwoNumberStatistics.h
  • sefondsecond in NumberStatistics.h

Fixed incomplete docstring:
Removed orphaned \param observations line from the first NumberStatistics constructor which only takes nmax:

/**
 * \brief Construct a new NumberStatistics object.
 * 
 * \param nmax  The maximum order of moments to be stored
 * 
 * For the error estimation nmax must be at least twice larger...
 */
NumberStatistics(int nmax = 16);
Original prompt

Fix minor typos and documentation issues identified during code review:

Issues to fix:

1. Incomplete docstring (NumberStatistics.h, lines 57-60)

The constructor documentation has an incomplete sentence:

/**
 * \brief Construct a new NumberStatistics object. 
 * 
 * \param nmax           The maximum order of moments to be stored
 * \param observations   The vector of   // ← Incomplete sentence

Should complete the sentence to describe what observations is.

2. Typo "consant" → "constant" (NumberStatistics.h, line 38)

/// Shifts all moments by a consant value

Should be "constant". Same typo exists in TwoNumberStatistics.h line 38.

3. Typo "sefond" → "second" (NumberStatistics.h, line 624)

/// \param  q               Order of the sefond moment

Should be "second".

Files to modify:

  • include/NumberStatistics.h
  • include/TwoNumberStatistics.h

This pull request was created as a result of the following prompt from Copilot chat.

Fix minor typos and documentation issues identified during code review:

Issues to fix:

1. Incomplete docstring (NumberStatistics.h, lines 57-60)

The constructor documentation has an incomplete sentence:

/**
 * \brief Construct a new NumberStatistics object. 
 * 
 * \param nmax           The maximum order of moments to be stored
 * \param observations   The vector of   // ← Incomplete sentence

Should complete the sentence to describe what observations is.

2. Typo "consant" → "constant" (NumberStatistics.h, line 38)

/// Shifts all moments by a consant value

Should be "constant". Same typo exists in TwoNumberStatistics.h line 38.

3. Typo "sefond" → "second" (NumberStatistics.h, line 624)

/// \param  q               Order of the sefond moment

Should be "second".

Files to modify:

  • include/NumberStatistics.h
  • include/TwoNumberStatistics.h

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits December 10, 2025 20:47
Co-authored-by: vlvovch <12958661+vlvovch@users.noreply.github.com>
Co-authored-by: vlvovch <12958661+vlvovch@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix minor typos and documentation issues identified during code review Fix typos in documentation comments Dec 10, 2025
Copilot AI requested a review from vlvovch December 10, 2025 20:50
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