Skip to content

Standardize test conventions and modernize docstring/lint tooling - #613

Open
sou-cheng-choi wants to merge 32 commits into
developfrom
develop_choi
Open

Standardize test conventions and modernize docstring/lint tooling#613
sou-cheng-choi wants to merge 32 commits into
developfrom
develop_choi

Conversation

@sou-cheng-choi

@sou-cheng-choi sou-cheng-choi commented Aug 31, 2026

Copy link
Copy Markdown
Member
  1. Renamed/replaced following the test_<area>_<topic>.py convention.
  2. Restructured test files to object classes if necessary.
  3. Implemented style gate scripts (check_test_style.py, check_docstring.py) to enforce strict filename and Google-style docstring conventions.
  4. Updated the CI system (Makefile, alltests.yml) to strictly gate Pull Requests (PRs) on these new style checks.
  5. Standardized documentation checks by integrating pydoclint into pyproject.toml and the build process.
  6. Added new documentation guidelines inCONTRIBUTING.md, docs/good_practices.md, and docs/tests.md.
  7. Removed (again) qmcpy/accumulate_data/__init__.py as it is dead code.

Comment thread test/test_ft_fast_transform_fallbacks.py Fixed
Comment thread test/test_ft_fast_transform_fallbacks.py Fixed
Comment thread test/test_ft_fast_transform_fallbacks.py Fixed
Comment thread test/test_ft_fast_transform_fallbacks.py Fixed
Comment thread test/test_ft_fast_transform_fallbacks.py Fixed
Comment thread test/test_ig_financial_option_quick.py Fixed
Comment thread test/test_ut_plot_and_stop.py Fixed
@sou-cheng-choi sou-cheng-choi changed the title Standardize test filenames and improve formatter diagnostics Standardize test filenames and Structure. Improve formatter diagnostics. Aug 31, 2026
@fjhickernell

Copy link
Copy Markdown
Member

Thanks, Sou-Cheng. I am curious. What if a test spans two areas, e.g., stopping criterion and kernel?

@sou-cheng-choi

sou-cheng-choi commented Sep 4, 2026

Copy link
Copy Markdown
Member Author

@fjhickernell

There is a label called "ee" for end-to-end tests. This is one option. Another option is to choose the primary category of the two.

I have made a commit to clarify the issue.

Comment thread test/test_sr_colab_notebooks.py Fixed
@sou-cheng-choi sou-cheng-choi changed the title Standardize test filenames and Structure. Improve formatter diagnostics. Refactor: Migrate test suite from pytest to unittest, standardize naming with area prefixes, and add style checking tools Sep 4, 2026
@sou-cheng-choi sou-cheng-choi changed the title Refactor: Migrate test suite from pytest to unittest, standardize naming with area prefixes, and add style checking tools Migrate test suite from pytest to unittest, standardize test-file naming with area prefixes, and add style checking tools Sep 4, 2026
Comment thread qmcpy/integrand/keister.py Fixed
@sou-cheng-choi sou-cheng-choi changed the title Migrate test suite from pytest to unittest, standardize test-file naming with area prefixes, and add style checking tools Standardize test conventions and modernize docstring/lint tooling Sep 7, 2026
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.

3 participants