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.

Sign up for GitHub

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

Jump to bottom

DOC: Add "Assert function selection guideline" doc in the new page "Tips for writing tests". #22389

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOC: Add "Assert function selection guideline" doc in the new page "Tips for writing tests". #22389

wants to merge 1 commit into from
+18 −0

Conversation

AtsushiSakai
Copy link
Member

@AtsushiSakai AtsushiSakai commented Jan 22, 2025 •
edited
Loading

Reference issue

Fix #21717

What does this implement/fix?

I added "Assert function selection guideline" doc based on this comment.
Also, I could not found a good page for writing unit test tips, so I added the new page "Tips for writing tests", and I put it in the new page.
image

Additional information

@github-actions github-actions bot added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org DX Everything related to making the experience of working on SciPy more pleasant labels Jan 22, 2025
@AtsushiSakai AtsushiSakai added DX Everything related to making the experience of working on SciPy more pleasant and removed DX Everything related to making the experience of working on SciPy more pleasant labels Jan 22, 2025
@AtsushiSakai
Copy link
Member Author

Sorry, I forgot [docs only]...

ev-br
ev-br approved these changes Jan 22, 2025
View reviewed changes
Copy link
Member

@ev-br ev-br left a comment

Choose a reason for hiding this comment

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

LGTM

j-bowhay
j-bowhay approved these changes Jan 22, 2025
View reviewed changes
Copy link
Member

@j-bowhay j-bowhay left a comment

Choose a reason for hiding this comment

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

+1 from me although I'd treat this as a recommendation rather than a strict requirement

I'll leave this open for a little bit incase anyone disagrees

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@j-bowhay j-bowhay j-bowhay approved these changes

@ev-br ev-br ev-br approved these changes

Assignees
No one assigned
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org DX Everything related to making the experience of working on SciPy more pleasant
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

DOC: assert_allclose instead of xp_assert_close is recommended in Developer Guide
3 participants
@AtsushiSakai @ev-br @j-bowhay