aeon icon indicating copy to clipboard operation
aeon copied to clipboard

[DOC] Fix Broken [Source] Link and Improve Documentation for suppress_output()

Open Kaustbh opened this issue 9 months ago • 8 comments

Reference Issues/PRs

FIxes: #2642

What does this implement/fix? Explain your changes.

  1. FIx Broken Source Link

    • Use inspect.unwrap() to handle wrapped or decorated functions to get the original source.
  2. Improved function documentataion

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

Any other comments?

PR checklist

For all contributions
  • [ ] I've added myself to the list of contributors. Alternatively, you can use the @all-contributors bot to do this for you after the PR has been merged.
  • [x] The PR title starts with either [ENH], [MNT], [DOC], [BUG], [REF], [DEP] or [GOV] indicating whether the PR topic is related to enhancement, maintenance, documentation, bugs, refactoring, deprecation or governance.
For new estimators and functions
  • [ ] I've added the estimator/function to the online API documentation.
  • [ ] (OPTIONAL) I've added myself as a __maintainer__ at the top of relevant files and want to be contacted regarding its maintenance. Unmaintained files may be removed. This is for the full file, and you should not add yourself if you are just making minor changes or do not want to help maintain its contents.
For developers with write access
  • [ ] (OPTIONAL) I've updated aeon's CODEOWNERS to receive notifications about future changes to these files.

Kaustbh avatar Mar 23 '25 08:03 Kaustbh