Skip to content

Commit

Permalink
[DOC] Add import location to HolidayFeatures docs (sktime#7401)
Browse files Browse the repository at this point in the history
<!--
Welcome to sktime, and thanks for contributing!
Please have a look at our contribution guide:
https://www.sktime.net/en/latest/get_involved/contributing.html
-->

#### Reference Issues/PRs
<!--
Example: Fixes sktime#1234. See also sktime#3456.

Please use keywords (e.g., Fixes) to create link to the issues or pull
requests
you resolved, so that they will automatically be closed when your pull
request
is merged. See
https://github.com/blog/1506-closing-issues-via-pull-requests.
If no issue exists, you can open one here:
https://github.com/sktime/sktime/issues
-->


#### What does this implement/fix? Explain your changes.
<!--
A clear and concise description of what you have implemented.
-->
When looking at HolidayFeatures API documentation, there's no mention of
module loading path. Only after looking to source I found it. When
giving examples I would expect imports too.

#### Does your contribution introduce a new dependency? If yes, which
one?
no
<!--
Only relevant if you changed pyproject.toml.
We try to minimize dependencies in the core dependency set. There
are also further specific instructions to follow for soft dependencies.
See here for handling dependencies in sktime:
https://www.sktime.net/en/latest/developer_guide/dependencies.html
-->

#### What should a reviewer concentrate their feedback on?
Nothing really
<!-- This section is particularly useful if you have a pull request that
is still in development. You can guide the reviews to focus on the parts
that are ready for their comments. We suggest using bullets (indicated
by * or -) and filled checkboxes [x] here -->

#### Did you add any tests for the change?
No. But I not sure that sktime's documentation is tested. I saw plugin
to docs - doctests, but it needs to be run, not only included into
conf.py.
<!-- This section is useful if you have added a test in addition to the
existing ones. This will ensure that further changes to these files
won't introduce the same kind of bug. It is considered good practice to
add tests with newly added code to enforce the fact that the code
actually works. This will reduce the chance of introducing logical bugs.
-->

#### Any other comments?
No
<!--
We value all user contributions, no matter how small or complex they
are. If you have any questions, feel free to post
in the dev-chat channel on the sktime discord
https://discord.com/invite/54ACzaFsn7. If we are slow to review (>3
working days), likewise feel free to ping us on discord. Thank you for
your understanding during the review process.
-->

#### PR checklist
<!--
Please go through the checklist below. Please feel free to remove points
if they are not applicable.
-->

##### For all contributions
- [x ] I've added myself to the [list of
contributors](https://github.com/sktime/sktime/blob/main/CONTRIBUTORS.md)
with any new badges I've earned :-)
How to: add yourself to the [all-contributors
file](https://github.com/sktime/sktime/blob/main/.all-contributorsrc) in
the `sktime` root directory (not the `CONTRIBUTORS.md`). Common badges:
`code` - fixing a bug, or adding code logic. `doc` - writing or
improving documentation or docstrings. `bug` - reporting or diagnosing a
bug (get this plus `code` if you also fixed the bug in the
PR).`maintenance` - CI, test framework, release.
See here for [full badge
reference](https://allcontributors.org/docs/en/emoji-key)
- [x] Optionally, for added estimators: I've added myself and possibly
to the `maintainers` tag - do this if you want to become the owner or
maintainer of an estimator you added.
See here for further details on the [algorithm maintainer
role](https://www.sktime.net/en/latest/get_involved/governance.html#algorithm-maintainers).
- [x] The PR title starts with either [ENH], [MNT], [DOC], or [BUG].
[BUG] - bugfix, [MNT] - CI, test framework, [ENH] - adding or improving
code, [DOC] - writing or improving documentation or docstrings.

##### For new estimators - does not apply
- [x] I've added the estimator to the API reference - in
`docs/source/api_reference/taskname.rst`, follow the pattern.
- [x] I've added one or more illustrative usage examples to the
docstring, in a pydocstyle compliant `Examples` section.
- [x] If the estimator relies on a soft dependency, I've set the
`python_dependencies` tag and ensured
dependency isolation, see the [estimator dependencies
guide](https://www.sktime.net/en/latest/developer_guide/dependencies.html#adding-a-soft-dependency).

<!--
Thanks for contributing!
-->
  • Loading branch information
mjste authored Nov 19, 2024
1 parent 5f871b1 commit d7f5823
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -3191,6 +3191,15 @@
"contributions": [
"doc"
]
},
{
"login": "mjste",
"name": "Michał Stefanik",
"avatar_url": "https://avatars.githubusercontent.com/mjste",
"profile": "https://github.com/mjste",
"contributions": [
"doc"
]
}
]
}
1 change: 1 addition & 0 deletions sktime/transformations/series/holiday/_holidayfeats.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ class HolidayFeatures(BaseTransformer):
Returns country holiday features with custom holiday windows
>>> from sktime.transformations.series.holiday import HolidayFeatures
>>> transformer = HolidayFeatures(
... calendar=country_holidays(country="FR"),
... return_categorical=True,
Expand Down

0 comments on commit d7f5823

Please sign in to comment.