Skip to content

docs: fix typos in AutoETS/AutoCES docstrings and README - #1223

Open
Zhu yizhang (godarrenw) wants to merge 1 commit into
Nixtla:mainfrom
godarrenw:fix-docstring-typos
Open

Zhu yizhang (godarrenw) wants to merge 1 commit into
Nixtla:mainfrom
godarrenw:fix-docstring-typos

Conversation

@godarrenw

Copy link
Copy Markdown

Description

Fixes six spelling mistakes: five in the AutoETS / AutoCES docstrings and the model-name validation message, plus one in the README. No identifiers or logic are touched.

Location Fix
models.py:713 (AutoETS) $N$ ommited componentsomitted
models.py:1017 (AutoCES) $P$ parialpartial
models.py:1018 (AutoCES) $N$ ommited componentsomitted
models.py:1019 (AutoCES) simple CES (withous seasonality)without
models.py:202 "...samples, serie has {n_samples:,}."series
README.md:38 Vist our [Installation Guide]Visit

Two of these are self-evident from their immediate surroundings — the same AutoCES docstring already writes partial correctly on line 1020 ($P$ for partial seasonality), and line 1019 itself writes without correctly later in the same sentence (without complex part).

models.py:202 is a message users see: it is raised when there aren't enough samples for prediction intervals.

The four docstring fixes appear on the generated AutoETS and AutoCES API pages.

How I checked

Candidates came from a spellcheck pass, then each was read in context. serie was confirmed to appear exactly once under python/ (everywhere else the code says series), so it is a genuine slip rather than house style. Conversely, lik, ans and nd — which a spellchecker also flags in arima.py / ets.py / ces.py — are real variable names carried over from the R implementation and were left alone.

python -m py_compile passes on models.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 the SimpleExponentialSmoothing / SeasonalExponentialSmoothing region (from line ~2246) and do not touch any of the lines above; #1217 and #1220 touch notebooks and CONTRIBUTING.md only.

Disclosure: prepared with AI assistance; each occurrence was read in context and verified manually.

Signed-off-by: Zhu yizhang <95731595+godarrenw@users.noreply.github.com>
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

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