Fixed #930 Improve ignore_trivial Docstring and Warnings

[seanlaw]

Fixed #930 and #929

Pull Request Checklist

Below is a simple checklist but please do not hesitate to ask for assistance!

• Fork, clone, and checkout the newest version of the code
• Create a new branch
• Make necessary code changes
• Install black (i.e., python -m pip install black or conda install -c conda-forge black)
• Install flake8 (i.e., python -m pip install flake8 or conda install -c conda-forge flake8)
• Install pytest-cov (i.e., python -m pip install pytest-cov or conda install -c conda-forge pytest-cov)
• Run black --exclude=".*\.ipynb" --extend-exclude=".venv" --diff ./ in the root stumpy directory
• Run flake8 --extend-exclude=.venv ./ in the root stumpy directory
• Run ./setup.sh dev && ./test.sh in the root stumpy directory
• Reference a Github issue (and create one if one doesn't already exist)

[gitnotebooks]

Review these changes at https://app.gitnotebooks.com/stumpy-dev/stumpy/pull/1110

[seanlaw]

@NimaSarajpoor Would you mind providing a review at your earliest convenience?

[NimaSarajpoor]

@seanlaw
I've added a few comments for your consideration.

[NimaSarajpoor]

Should we remove the last sentence?

Default is None which corresponds to a self-join.

This is true if we look at it from stump's perspective. From this function's standpoint, I feel that we should not provide such statement. Are we allowing the function to accept None for T_B? If yes, then we can modify this function to do what the new function core.check_self_join does since we can identify if we are dealing with self-join or not. (see the response I've provided for your comment in the new function)

[seanlaw]

@NimaSarajpoor I've made a few small changes based on your review. I think it's ready to be merged unless anything stands out to you?

[NimaSarajpoor]

Nothing stands out to me. All good! 👍

[seanlaw]

Thanks @NimaSarajpoor!