Repository navigation
Fix typos in Markdown docs, generated fundamental comments and messages - #10215
Conversation
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>
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Closes #10213
Description
One sweep over the text the earlier sweeps (#10120, #10166, #10194) left out: 153 lines in 91 files, prose only.
Markdown (
*.mdoutsideData/)Common/Securities/Positions/readme.md:overriden→overridden,through the lense of→through the lens of.Common/Data/Fundamental/Generated/*doc comments (only///lines)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
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
codespell2.4.3 over every tracked file outsideData/(not only.cs/.pycomments).\b(\w+)\s+\1\b) over the same files, read by hand.///comments, string literals, Python strings/docstrings and other text files that isn't also an identifier in the code, checked against hunspellen_USand read by hand.Left as they are on purpose
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 inTests/Research/RegressionTemplates).Symbol Symbol { get; }in Markdown,imply that that industryinAssetClassification,update-alternatives ... java java,auto autoin CSS.UE/OTauditor codes, theDeactiveshare-class status, tickers (HSI,NWE,ZAR,ANE,MIS...), thesimpypackage,implementorsin thecontainers.dev/implementorsURL, and theStaticsregion name.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_compileon the changed Python files andjson.loadon the changed notebooks: OK.