Skip to content

[DOC] Add usage example to DontUpdate docstring#9646

Open
AasthaRai0 wants to merge 1 commit intosktime:mainfrom
AasthaRai0:add-dontupdate-example
Open

[DOC] Add usage example to DontUpdate docstring#9646
AasthaRai0 wants to merge 1 commit intosktime:mainfrom
AasthaRai0:add-dontupdate-example

Conversation

@AasthaRai0
Copy link
Copy Markdown

Reference Issues/PRs

Fixes #4264

What does this implement/fix? Explain your changes.

Added a usage example to the DontUpdate estimator docstring
in numpydoc style, as requested in #4264.

The example demonstrates basic usage:

  • Wrapping a NaiveForecaster with DontUpdate
  • fit() call
  • predict() call
  • update() call (which DontUpdate ignores by design)

Does your contribution introduce a new dependency? If yes, which one?

No

What should a reviewer concentrate their feedback on?

Please check if the example follows correct numpydoc style
and covers the expected behavior of DontUpdate.

Did you add any tests for the change?

No new tests added - this is a documentation-only change.

PR checklist

  • The PR title starts with either [ENH], [MNT], [DOC], or [BUG].

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.

[ENH] add at least one usage example to docstrings of estimators

1 participant