Skip to content

Fix typos in Markdown docs, generated fundamental comments and messages - #10215

Merged
quantconnect-kronos[bot] merged 1 commit into
masterfrom
kronos/bug-10213-docs-generated-typos
Nov 20, 2026
Merged

quantconnect-kronos[bot] merged 1 commit into
masterfrom
kronos/bug-10213-docs-generated-typos

Conversation

@quantconnect-kronos

Copy link
Copy Markdown
Contributor

Closes #10213

Description

One sweep over the text the earlier sweeps (#10120, #10166, #10194) left out: 153 lines in 91 files, prose only.

Markdown (*.md outside Data/)

  • Common/Securities/Positions/readme.md: overriden → overridden, through the lense of → through the lens of.

Common/Data/Fundamental/Generated/* doc comments (only /// lines)

  • Repeated words: that that firm → that the firm (2 lines), is typically typically available → is typically available (2 lines).
  • unusal → unusual (26 lines), pecentage → percentage (2), energy assistances programs → energy assistance programs (2).

String literals (exception, debug and log messages)

  • "Unexpect margin used/remaining!" → "Unexpected ..." in 66 regression algorithms' checks.
  • meesage, submittion, receieved, recieving, Recieved, groupd → group, weigths, looback → lookback, overrride, sucessfully, positve, unsecure → insecure, approxiation, genearted, could't, wth, swalloed, inssuficient, undelrying, aregular → a regular, viceversa → vice versa, Atleast one renko bar were emitted → At least one renko bar was emitted.

Python docstrings, notebooks and scripts

  • Docstrings: hightest, recepient of the Noble Prize → recipient of the Nobel Prize, execued ... a change to regain → executed ... a chance to regain, coeffficient, extendes (plus the matching C# doc comments of the same two models, which earlier sweeps missed).
  • Research/*.ipynb: fetchs → fetches; Research/QuantConnect.csx: in the beggining of → at the beginning of; DockerfileLeanFoundation: contraint → constraint.

How it was found

  • codespell 2.4.3 over every tracked file outside Data/ (not only .cs/.py comments).
  • A case-sensitive repeated-word regex (\b(\w+)\s+\1\b) over the same files, read by hand.
  • For typos codespell's dictionary misses: every lowercase word in Markdown, generated /// comments, string literals, Python strings/docstrings and other text files that isn't also an identifier in the code, checked against hunspell en_US and read by hand.

Left as they are on purpose

  • Identifiers, public or not (Serie, liveTime, outter, datas, splitted, lamda, missings ...), and test data that only feeds a test ({"Sucess": true}, the "outter" exception message the same test asserts, truncated notebook JSON in Tests/Research/RegressionTemplates).
  • Code samples and valid repeats: Symbol Symbol { get; } in Markdown, imply that that industry in AssetClassification, update-alternatives ... java java, auto auto in CSS.
  • Vendor codes and terms: UE/OT auditor codes, the Deactive share-class status, tickers (HSI, NWE, ZAR, ANE, MIS ...), the simpy package, implementors in the containers.dev/implementors URL, and the Statics region name.
  • Accepted spellings: cancelation, requestor, invokable, re-use, maths.

Every file has equal additions and deletions (one-for-one line edits; line endings and BOMs unchanged). No test asserts any changed message.

Testing

  • dotnet build /p:Configuration=Release /v:quiet /p:WarningLevel=1 QuantConnect.Lean.sln: 0 errors.
  • dotnet test ./Tests/bin/Release/QuantConnect.Tests.dll --filter "TestCategory!=TravisExclude&TestCategory!=ResearchRegressionTests": Passed! - Failed: 0, Passed: 39845, Skipped: 100, Total: 39945.
  • python3 -m py_compile on the changed Python files and json.load on the changed notebooks: OK.
  • Re-running codespell and the repeated-word regex on the branch leaves only the cases listed above.
  • No end-to-end run: only message and comment text changes, so the code paths are the same.

One sweep over the text the earlier comment sweeps skipped: Markdown
files, the generated fundamental doc comments, string literals,
Python docstrings and script comments. Repeated words in the
generated fundamental comments ("that that firm", "typically
typically") are removed too. Only prose changes; identifiers stay.

Closes #10213

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@quantconnect-kronos quantconnect-kronos Bot added kronos:develop:working develop: in progress kronos:review Request review labels Nov 20, 2026
@quantconnect-kronos-reviewer quantconnect-kronos-reviewer Bot added kronos:review:queued review: queued kronos:review:working review: in progress and removed kronos:review Request review kronos:review:queued review: queued labels Nov 20, 2026
@quantconnect-kronos-reviewer
quantconnect-kronos-reviewer Bot marked this pull request as ready for review November 20, 2026 14:18

@quantconnect-kronos-reviewer quantconnect-kronos-reviewer Bot 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.

Approving. Every changed line is a doc comment, Markdown, a code comment or the text of a message. No identifier changes, and no test or other code in this repository compares against any of the old strings. Re-running codespell on the branch leaves only identifiers, tickers, vendor codes and test fixtures, as the description lists. The scope matches the issue, which asks for the generated fundamental comments and user-facing strings to be included.

Label risk:low: text-only, one commit that is easy to revert, and CI is green.

@quantconnect-kronos-reviewer quantconnect-kronos-reviewer Bot added risk:low Low risk and removed kronos:review:working review: in progress labels Nov 20, 2026
@quantconnect-kronos quantconnect-kronos Bot added the kronos:review Request review label Nov 20, 2026
@quantconnect-kronos-reviewer quantconnect-kronos-reviewer Bot added kronos:review:queued review: queued and removed kronos:review Request review labels Nov 20, 2026
@quantconnect-kronos-reviewer-2 quantconnect-kronos-reviewer-2 Bot added kronos:review:working review: in progress and removed kronos:review:queued review: queued labels Nov 20, 2026

@quantconnect-kronos-reviewer-2 quantconnect-kronos-reviewer-2 Bot 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.

Approved. Local checks confirm that all 14 changed Python files compile and retain their AST structure apart from string text, and both notebooks retain their metadata and saved outputs. The C# edits are confined to comments and diagnostic string contents, with no changes to identifiers or interpolated expressions. No correctness findings.

@quantconnect-kronos-reviewer-2 quantconnect-kronos-reviewer-2 Bot removed the kronos:review:working review: in progress label Nov 20, 2026
@quantconnect-kronos
quantconnect-kronos Bot merged commit d1aa59f into master Nov 20, 2026
8 checks passed
@quantconnect-kronos
quantconnect-kronos Bot deleted the kronos/bug-10213-docs-generated-typos branch November 20, 2026 14:34
@quantconnect-kronos quantconnect-kronos Bot removed the kronos:develop:working develop: in progress label Nov 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

risk:low Low risk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix typos in Markdown docs and generated fundamental comments in one pass

0 participants