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

Add references to test statistics and cross references #158

Merged
merged 6 commits into from
Aug 24, 2021

Conversation

ami232
Copy link
Contributor

@ami232 ami232 commented Aug 17, 2021

This PR addresses issues #28 and #40.

  • It adds references to the docstrings of the test statistics functions. Minor fixes are also made to the docstrings in the stat_tests to unify style, fix typos or fix format.
    • Also, wherever they are mentioned across the documentation, they are cross referenced to the page where they are described.

image

  • Add cross references to md files in docs/api and unify style.

Copy link
Collaborator

@Matgrb Matgrb left a comment

Choose a reason for hiding this comment

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

Overall looks very good, i left some small comments.

Thanks a lot for the contribution! This will make the package easier to use :)

probatus/stat_tests/distribution_statistics.py Outdated Show resolved Hide resolved
probatus/stat_tests/psi.py Show resolved Hide resolved
Copy link
Collaborator

@Matgrb Matgrb left a comment

Choose a reason for hiding this comment

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

Looks great! thanks for making these changes!

@Matgrb Matgrb merged commit 5ef8023 into ing-bank:main Aug 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants