Skip to content

[DOC] Fix typo in docstrings: "logartihms" -> "logarithms"#813

Merged
fkiraly merged 1 commit intosktime:mainfrom
MayankSharma-2812:fix-typo-docstrings
Mar 7, 2026
Merged

[DOC] Fix typo in docstrings: "logartihms" -> "logarithms"#813
fkiraly merged 1 commit intosktime:mainfrom
MayankSharma-2812:fix-typo-docstrings

Conversation

@MayankSharma-2812
Copy link
Contributor

Reference Issues/PRs

Fixes #812

What does this implement/fix? Explain your changes.

Fixed a typo in the docstrings of distribution classes where "logartihms" was incorrectly spelled instead of "logarithms". This was corrected in two locations:

  • Line 928: log_pmf method docstring
  • Line 1938: log_pdf method docstring

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

No, this is a documentation-only fix with no new dependencies.

What should a reviewer concentrate their feedback on?

  • Verify that the spelling correction from "logartihms" to "logarithms" is correct
  • Ensure no other similar typos exist in the same file
  • Confirm the change maintains consistency with other docstrings in the codebase

Did you add any tests for the change?

No, this is a documentation-only typo fix that doesn't require additional tests.

Any other comments?

This is a minor documentation fix that improves the professionalism and quality of the codebase. The change only affects docstrings and has no impact on code functionality.

PR checklist

For all contributions
  • I've added myself to the list of contributors with any new badges I've earned :-)
    How to: add yourself to the all-contributors file in the skpro 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
  • 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
  • I've added the estimator to the API reference - in docs/source/api_reference/taskname.rst, follow the pattern.
  • I've added one or more illustrative usage examples to the docstring, in a pydocstyle compliant Examples section.
  • If the estimator relies on a soft dependency, I've set the python_dependencies tag and ensured
    dependency isolation, see the estimator dependencies guide.

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

@fkiraly fkiraly added module:probability&simulation probability distributions and simulators documentation Documentation & tutorials labels Mar 7, 2026
@fkiraly fkiraly changed the title Fix typo in docstrings: "logartihms" -> "logarithms" [DOC] Fix typo in docstrings: "logartihms" -> "logarithms" Mar 7, 2026
@fkiraly fkiraly merged commit fdcdcf8 into sktime:main Mar 7, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation & tutorials module:probability&simulation probability distributions and simulators

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix typo in docstrings: "logartihms" -> "logarithms"

2 participants