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

[Kaustbh]

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.
• 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.

[aeon-actions-bot]

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ $\color{#F3B9F8}{\textsf{documentation}}$ ].
I have added the following labels to this PR based on the changes made: [ $\color{#2C2F20}{\textsf{testing}}$ ]. Feel free to change these if they do not properly represent the PR.

The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.

If our pre-commit code quality check fails, any trivial fixes will automatically be pushed to your PR unless it is a draft.

Don't hesitate to ask questions on the aeon Slack channel if you have any.

PR CI actions

These checkboxes will add labels to enable/disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.

• Run pre-commit checks for all files
• Run mypy typecheck tests
• Run all pytest tests and configurations
• Run all notebook example tests
• Run numba-disabled codecov tests
• Stop automatic pre-commit fixes (always disabled for drafts)
• Disable numba cache loading
• Push an empty commit to re-run CI checks

[Kaustbh]

I plan to add test cases in a follow-up commit.

[MatthewMiddlehurst]

Your examples are failing our tests currently. Please have a look through the logs and resolve.

[Kaustbh]

Hi, I am not getting why the test are failing could you please help me identify what might be going wrong?

[MatthewMiddlehurst]

Hi, the doctest error message seems pretty clear to me. Are you checking the pytest log for the actions?

[Kaustbh]

I think the tests are failing because doctests is not able to capture stderr by default.

[Kaustbh]

I noticed that the broken source link issue is not limited to suppress_output(). I encountered the same problem in the distances module as well. For example, the function dtw_alignment_path leads to a 404 page (see the screenshot below):

This was caused by inspect not properly handling decorated functions (e.g., with @njit). This has now been addressed as part of this PR by unwrapping the decorators when resolving the source file.

[SebastianSchmidl]

Nice work!

[Kaustbh]

Thanks a lot. Looking forward to keep contributing more!

[MatthewMiddlehurst]

This does not seem to be the case above?

[Kaustbh]

Hi, sorry but I am not getting what you are saying, are you talking about sys.stderr = sys.stdout ?

[MatthewMiddlehurst]

yes. But checking again you do actually do it again above. If you do not include it is there just no output?

[MatthewMiddlehurst]

These imports are a bit inconsistent. I think you only have to import it once?

[Kaustbh]

I will fix this.