docs: add docstrings to five CLI worker functions - #76
Conversation
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.
|
Thank you for signing the SciTeX CLA. Your contribution can now be reviewed. |
|
I have read the CLA Document and I hereby sign the CLA |
|
The All other checks passed: pytest-matrix (py3.11, 3.12, 3.13), import-smoke, and rtd-sphinx-build. |
|
Thank you — this is careful work. We verified every documented claim against the source (arg names, defaults, the 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. |
|
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 |
|
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! |
|
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, |
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 summaryrun_tests_execute— keyword-only args documented with return values (0 on success, 1 on error)run_tests_describe— keyword-only args and return documentedrun_tests_recommend— keyword-only args documented includingsample_sizesas comma-separated stringrun_format_pvalue— single-line summaryVerification:
pytest tests/scitex_stats/_cli/ -v— 178 passed, 0 failed