DOC: Fix typos in docstrings and documentation#697
Merged
Conversation
Fix several spelling typos found with codespell: - 'ot' -> 'to' in PanelData and asset-pricing covariance docstrings - 'neeeding' -> 'needing' in the _OLS docstring - 'Regresssion' -> 'Regression' in the README - 'compatability' -> 'compatibility' and 'singelton' -> 'singleton' in the change logs, plus a duplicated 'the' and 'Verison' -> 'Version'.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #697 +/- ##
=======================================
Coverage 99.54% 99.54%
=======================================
Files 101 101
Lines 17423 17423
Branches 1430 1430
=======================================
Hits 17344 17344
Misses 29 29
Partials 50 50
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Owner
|
Thanks. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DOC: Fix typos in docstrings and documentation
Ran codespell over the package and docs and fixed the genuine spelling
mistakes (skipped the false positives like
coo, thete/oeformatkeys, and
pres).Docstrings (these render in the API docs):
linearmodels/asset_pricing/covariance.py- "Degree of freedom valueot use" -> "to use" (HeteroskedasticCovariance and KernelCovariance).
linearmodels/iv/model.py-_OLSdocstring "when neeeding a supportedpublic API" -> "needing".
linearmodels/panel/data.py- "Index level 0 is assumed ot be entity"-> "to be entity".
Docs / README:
README.md- "High-dimensional Regresssion" -> "Regression".doc/source/changes/4.0.rst- "compatability" -> "compatibility" (x3),"singelton" -> "singleton", and a duplicated "the the" -> "the".
doc/source/changes/5.0.rst- "Verison" -> "Version" (x2) in thesection headings (same length, so the underlines stay valid).
Text-only; no code changes. The three touched modules still byte-compile.