Skip to content

docs: add docstrings to five CLI worker functions - #76

Merged
ywatanabe1989 merged 1 commit into
scitex-ai:developfrom
lesbass:feature/add-docstrings-cli-workers
Aug 11, 2026
Merged

docs: add docstrings to five CLI worker functions#76
ywatanabe1989 merged 1 commit into
scitex-ai:developfrom
lesbass:feature/add-docstrings-cli-workers

Conversation

@lesbass

@lesbass lesbass commented Jul 21, 2026

Copy link
Copy Markdown

Closes #74.

Adds docstrings to the five public CLI worker functions in src/scitex_stats/_cli/stats.py, following the existing convention set by the private helpers (_read_data, _select_column, _emit):

  • run_tests_list — single-line summary
  • run_tests_execute — keyword-only args documented with return values (0 on success, 1 on error)
  • run_tests_describe — keyword-only args and return documented
  • run_tests_recommend — keyword-only args documented including sample_sizes as comma-separated string
  • run_format_pvalue — single-line summary

Verification:

  • AST check confirms all five public functions now have docstrings
  • pytest tests/scitex_stats/_cli/ -v — 178 passed, 0 failed

Add docstrings to run_tests_list, run_tests_execute, run_tests_describe,
run_tests_recommend, and run_format_pvalue in stats.py, following the
existing convention set by the private helpers in the same file.
@github-actions

github-actions Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Thank you for signing the SciTeX CLA. Your contribution can now be reviewed.
Posted by the CLA Assistant Lite bot.

@lesbass

lesbass commented Jul 21, 2026

Copy link
Copy Markdown
Author

I have read the CLA Document and I hereby sign the CLA

github-actions Bot added a commit that referenced this pull request Jul 21, 2026
@lesbass

lesbass commented Jul 21, 2026

Copy link
Copy Markdown
Author

The quality-audit / audit CI failure is pre-existing and unrelated to this PR — all 14 errors are [PS-221 §3 public-extra-not-closed-under-all] in pyproject.toml, a file this PR does not touch. The failure is caused by scitex-dev v0.34.0 adding new project-structure rules that the repository has not adopted yet.

All other checks passed: pytest-matrix (py3.11, 3.12, 3.13), import-smoke, and rtd-sphinx-build.

@ywatanabe1989

Copy link
Copy Markdown
Collaborator

Thank you — this is careful work. We verified every documented claim against the source (arg names, defaults, the sample_sizes comma-string semantics, paired overriding design, the 0/1 return codes) and it all checks out. CLA is signed, and the red quality-audit check is pre-existing repo-wide debt on our side (being fixed in #78) — not your PR's problem.

One process wrinkle we owe both of you fairness on: issue #74 was assigned to @varshu55 a few hours before this PR was opened — they asked first and we assigned it. To keep assignments meaningful for first-time contributors, we'll hold this PR until July 28 to give the assignee their shot; if #74 has no PR from them by then, we'll merge this one. We know an assignee field is easy to miss — for future picks, a quick "I'll take this" comment on the issue first avoids the collision.

If you'd like something that's yours right away, these are open and unassigned, same shape as this one: scitex-io #144 (README fix), #145 (round-trip tests), #146 / #147 (actionable error messages). Say the word and we'll assign any of them to you.

@lesbass

lesbass commented Jul 31, 2026

Copy link
Copy Markdown
Author

Friendly follow-up on this PR: per your note on Jul 21, the hold window ended July 28, and I don't see any PR from the #74 assignee. Since the condition you set has been met, I wanted to check whether anything else is needed from my side before this can land — happy to rebase, adjust the docstrings, or help in any other way. Thanks again for the careful review!

@lesbass

lesbass commented Aug 11, 2026

Copy link
Copy Markdown
Author

Hi maintainers, just a gentle follow-up on this PR (now 21 days old). The hold window ended July 28 and the documentation changes have been verified. Could you let us know if you plan to merge, or if we should close this PR? Thanks!

@ywatanabe1989
ywatanabe1989 merged commit 1a2f28d into scitex-ai:develop Aug 11, 2026
8 of 10 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 11, 2026
@ywatanabe1989

ywatanabe1989 commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator

Hi @lesbass,

Thank you so much for your contribution, and I’m very sorry for the delayed response. Your contribution means a lot to this project and helps make SciTeX a truly community-driven project for science.

I really appreciate your patience and support!

Best regards,
Yusuke

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants