Skip to content

Edit testing doc and add admonition to Grzegorz blog post on Qt testing#635

Merged
TimMonko merged 11 commits intonapari:mainfrom
willingc:test-docs
Apr 12, 2025
Merged

Edit testing doc and add admonition to Grzegorz blog post on Qt testing#635
TimMonko merged 11 commits intonapari:mainfrom
willingc:test-docs

Conversation

@willingc
Copy link
Copy Markdown
Contributor

@willingc willingc commented Mar 17, 2025

References and relevant issues

Closes #494

Description

This PR edits the testing page. After reviewing each section, I added
information that would be helpful for contributors. An admonition was
added to reference Grzegorz' blog post on avoiding segfaults in Qt tests.

Also rearranged some sections like mocking to group common tasks before specifics.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 17, 2025
Copy link
Copy Markdown
Contributor

@TimMonko TimMonko left a comment

Choose a reason for hiding this comment

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

Overall great changes. Was about to play with some testing things (to see if I can replicate the Windows seg faults on my PC), so will use this PR as the resource and report back.

Comment thread docs/developers/contributing/testing.md Outdated
Comment thread docs/developers/contributing/testing.md Outdated
Comment thread docs/developers/contributing/testing.md Outdated
Comment thread docs/developers/contributing/testing.md Outdated
Copy link
Copy Markdown
Contributor

@TimMonko TimMonko 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! I like how the new change allows us to evolve by pointing to the necessary page, and not having to maintain the material in two places. Thanks!!

@willingc
Copy link
Copy Markdown
Contributor Author

CI error for docs build is unrelated to this PR.

@TimMonko
Copy link
Copy Markdown
Contributor

not sure how to retrigger circleCI action? I'll just update branch

@TimMonko TimMonko added this to the 0.6.0 milestone Apr 12, 2025
@TimMonko
Copy link
Copy Markdown
Contributor

I will say Circle was being finnicky early when I was merging into napari/napari

@willingc
Copy link
Copy Markdown
Contributor Author

Thanks @TimMonko.

For the future, you can click through to the Circle CI dashboard and the upper right has a button to rerun Circle CI.

Screenshot 2025-04-11 at 8 37 38 PM

@TimMonko
Copy link
Copy Markdown
Contributor

Appreciate YOU @willingc

Copy link
Copy Markdown
Member

@psobolewskiPhD psobolewskiPhD left a comment

Choose a reason for hiding this comment

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

thanks @willingc

@psobolewskiPhD psobolewskiPhD added the Full docs preview/ready to merge Adding this label will trigger a full docs build for previewing changes. Also @napari-bot make html label Apr 12, 2025
@TimMonko TimMonko merged commit ac8fefd into napari:main Apr 12, 2025
9 checks passed
@github-actions github-actions bot removed the Full docs preview/ready to merge Adding this label will trigger a full docs build for previewing changes. Also @napari-bot make html label Apr 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add documentation about avoiding segfaults in Qt tests

3 participants