Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] adds missing import statements in numba distance docstrings #4376

Merged
merged 7 commits into from Mar 29, 2023

Conversation

JonathanBechtel
Copy link
Contributor

Reference Issues/PRs

Adds to #4264, also references #4324

What does this implement/fix? Explain your changes.

Distance calculation docstrings currently do not import the actual method from sktime, which makes it inconvenient to use the examples for quick use. This PR adds the import statement for each distance calculation in the docstring.

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

No

What should a reviewer concentrate their feedback on?

I would focus on the import statement added to each example, to make sure it matches the actual calculation being demonstrated

Did you add any tests for the change?

Since this is an update to a docstring I didn't add a test.

Any other comments?

None for now.

For all contributions
  • [ x] I've added myself to the list of contributors.
  • [x ] Optionally, I've updated sktime's CODEOWNERS to receive notifications about future changes to these files.
  • [x ] The PR title starts with either [ENH], [MNT], [DOC], or [BUG] indicating whether the PR topic is related to enhancement, maintenance, documentation, or bug.

Copy link
Collaborator

@fkiraly fkiraly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Still wondering how to test this...

@fkiraly fkiraly added the documentation Documentation & tutorials label Mar 29, 2023
@fkiraly fkiraly merged commit 46da039 into sktime:main Mar 29, 2023
20 checks passed
@fkiraly fkiraly changed the title [DOC] Updated Distance Calculation Docstrings [DOC] adds missing import statements in numba distance docstrings Mar 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation & tutorials
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants