Skip to content

TST: add doc-string testing infraestructure - #1130

Merged
adivijaykumar merged 12 commits into
bilby-dev:mainfrom
mj-will:add-doc-string-tests
Aug 26, 2026
Merged

TST: add doc-string testing infraestructure#1130
adivijaykumar merged 12 commits into
bilby-dev:mainfrom
mj-will:add-doc-string-tests

Conversation

@mj-will

@mj-will mj-will commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

Uses pytest --doctest-modules bilby to test all the codes in doc-strings.

I had to change some of examples to make the tests pass

Closes #473

To-do

  • Decided how to to best handle optional dependencies

@mj-will mj-will added testing ci documentation A change to docstrings or doc pages labels Aug 25, 2026
@mj-will
mj-will marked this pull request as ready for review August 26, 2026 08:24
@mj-will
mj-will requested a review from a team August 26, 2026 08:36

@GregoryAshton GregoryAshton left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This looks good to me. I guess the proof is in the CI :)

@mj-will
mj-will requested a review from a team August 26, 2026 10:12

@adivijaykumar adivijaykumar left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good to me, but #1126 will need changes following this?

@mj-will

mj-will commented Aug 26, 2026

Copy link
Copy Markdown
Collaborator Author

Looks good to me, but #1126 will need changes following this?

Yeah, it would like need a small tweak. Alternatively, we can wait until that one is merged.

@adivijaykumar

Copy link
Copy Markdown
Collaborator

I think we should merge!

@adivijaykumar
adivijaykumar added this pull request to the merge queue Aug 26, 2026
Merged via the queue into bilby-dev:main with commit 9fae6ae Aug 26, 2026
20 checks passed
@mj-will mj-will added this to the 3.0.0 milestone Aug 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci documentation A change to docstrings or doc pages testing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add doctest to the bilby test suite

3 participants