docs: fix typos in AutoETS/AutoCES docstrings and README - #1223
Open
Zhu yizhang (godarrenw) wants to merge 1 commit into
Open
Zhu yizhang (godarrenw) wants to merge 1 commit into
Zhu yizhang (godarrenw) wants to merge 1 commit into
Conversation
Signed-off-by: Zhu yizhang <95731595+godarrenw@users.noreply.github.com>
|
|
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
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.
Description
Fixes six spelling mistakes: five in the
AutoETS/AutoCESdocstrings and the model-name validation message, plus one in the README. No identifiers or logic are touched.models.py:713(AutoETS)$N$ ommited components→omittedmodels.py:1017(AutoCES)$P$ parial→partialmodels.py:1018(AutoCES)$N$ ommited components→omittedmodels.py:1019(AutoCES)simple CES (withous seasonality)→withoutmodels.py:202"...samples, serie has {n_samples:,}."→seriesREADME.md:38Vist our [Installation Guide]→VisitTwo of these are self-evident from their immediate surroundings — the same
AutoCESdocstring already writespartialcorrectly on line 1020 ($P$ for partial seasonality), and line 1019 itself writeswithoutcorrectly later in the same sentence (without complex part).models.py:202is a message users see: it is raised when there aren't enough samples for prediction intervals.The four docstring fixes appear on the generated
AutoETSandAutoCESAPI pages.How I checked
Candidates came from a spellcheck pass, then each was read in context.
seriewas confirmed to appear exactly once underpython/(everywhere else the code saysseries), so it is a genuine slip rather than house style. Conversely,lik,ansandnd— which a spellchecker also flags inarima.py/ets.py/ces.py— are real variable names carried over from the R implementation and were left alone.python -m py_compilepasses onmodels.py. Documentation only, no functional change.I checked the open documentation PRs for overlap: #1096 also touches
python/statsforecast/models.py, but its changes are in theSimpleExponentialSmoothing/SeasonalExponentialSmoothingregion (from line ~2246) and do not touch any of the lines above; #1217 and #1220 touch notebooks andCONTRIBUTING.mdonly.Disclosure: prepared with AI assistance; each occurrence was read in context and verified manually.