Doc string fixes

[jan-janssen]

Summary by CodeRabbit

• Documentation

  • Improved docstring formatting and clarity for several scheduler-related functions, including parameter descriptions and indentation/line wrapping.
  • No changes to behavior, control flow, or public APIs.

• Style

  • Applied formatting-only updates to internal documentation blocks for consistency and readability.

• Tests

  • No test changes required.

• Chores

  • Maintenance-only cleanup; estimated review effort is low.

[coderabbitai]

Walkthrough

Docstring formatting adjustments (indentation and line wrapping) were applied in interactive task scheduler modules: blockallocation.py and onetoone.py. No code logic, control flow, or API signatures changed.

Changes

Cohort / File(s)	Summary of changes
BlockAllocation scheduler docstrings executorlib/task_scheduler/interactive/blockallocation.py	Reflowed/indented docstrings for BlockAllocationTaskScheduler.submit, BlockAllocationTaskScheduler.shutdown, and _execute_multiple_tasks; no functional edits.
One-to-one scheduler docstrings executorlib/task_scheduler/interactive/onetoone.py	Indentation-only docstring tweaks for hostname_localhost parameter in _wrap_execute_task_in_separate_process and _execute_task_in_thread.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Update docstrings to improve consistency #764 — Also edits the BlockAllocationTaskScheduler.submit docstring (resource_dict), indicating overlap in documentation targets.
• Refactor interactive task scheduler #798 — Refactors/renames related interactive scheduler functions touched by these docstring updates.

Poem

I twitch my whiskers, neat and bright,
Docstrings aligned, margins just right.
No code was moved, no flow took flight—
Just tidy notes for future sight.
Thump-thump! I hop through lines of light,
A rabbit scribe by moonlit night. 🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch doc_string_fixes

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.75%. Comparing base (1eaffea) to head (f3ffe3e).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #805   +/-   ##
=======================================
  Coverage   97.75%   97.75%           
=======================================
  Files          32       32           
  Lines        1468     1468           
=======================================
  Hits         1435     1435           
  Misses         33       33           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (4)

executorlib/task_scheduler/interactive/onetoone.py (1)

179-184: Polish grammar and boolean literal in hostname_localhost docs.

Minor clarity nits: add “is”, use “lookup”, proper macOS casing, and Python’s True.

-                                      context of an HPC cluster this essential to be able to communicate to an
+                                      context of an HPC cluster this is essential to be able to communicate to an
                                       Executor running on a different compute node within the same allocation. And
-                                      in principle any computer should be able to resolve that their own hostname
-                                      points to the same address as localhost. Still MacOS >= 12 seems to disable
-                                      this look up for security reasons. So on MacOS it is required to set this
-                                      option to true
+                                      in principle any computer should be able to resolve that their own hostname
+                                      points to the same address as localhost. Still macOS 12+ seems to disable
+                                      this lookup for security reasons. So on macOS it is required to set this
+                                      option to True

executorlib/task_scheduler/interactive/blockallocation.py (3)

119-128: Tighten wording and naming in resource_dict bullets.

Consistent terminology: “Open MPI”, hyphenate “command-line”, capitalize “Python”.

-                                  - gpus_per_core (int): number of GPUs per worker - defaults to 0
-                                  - cwd (str/None): current working directory where the parallel python task is executed
-                                  - openmpi_oversubscribe (bool): adds the `--oversubscribe` command line flag (OpenMPI
-                                                                  and SLURM only) - default False
+                                  - gpus_per_core (int): number of GPUs per worker - defaults to 0
+                                  - cwd (str/None): current working directory where the parallel Python task is executed
+                                  - openmpi_oversubscribe (bool): adds the `--oversubscribe` command-line flag (Open MPI
+                                                                  and SLURM only) - default False
                                   - slurm_cmd_args (list): Additional command line arguments for the srun call (SLURM
                                                            only)
                                   - error_log_file (str): Name of the error log file to use for storing exceptions
                                                           raised by the Python functions submitted to the Executor.

---

151-154: Parameter docs: minor consistency/clarity tweaks.

Add types, punctuation after True, and avoid underscore in prose.

-            wait: If True then shutdown will not return until all running futures have finished executing and the
-                  resources used by the parallel_executors have been reclaimed.
-            cancel_futures: If True then shutdown will cancel all pending futures. Futures that are completed or running
-                            will not be cancelled.
+            wait (bool): If True, shutdown will not return until all running futures have finished executing and the
+                         resources used by the parallel executors have been reclaimed.
+            cancel_futures (bool): If True, cancel all pending futures. Futures that are completed or running
+                                   will not be cancelled.

---

199-208: Mirror the hostname_localhost doc nits here as well.

Same minor grammar/casing fixes as in onetoone.py.

-        hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
-                                      context of an HPC cluster this essential to be able to communicate to an
+        hostname_localhost (boolean): use localhost instead of the hostname to establish the zmq connection. In the
+                                      context of an HPC cluster this is essential to be able to communicate to an
                                       Executor running on a different compute node within the same allocation. And
-                                      in principle any computer should be able to resolve that their own hostname
-                                      points to the same address as localhost. Still MacOS >= 12 seems to disable
-                                      this look up for security reasons. So on MacOS it is required to set this
-                                      option to true
+                                      in principle any computer should be able to resolve that their own hostname
+                                      points to the same address as localhost. Still macOS 12+ seems to disable
+                                      this lookup for security reasons. So on macOS it is required to set this
+                                      option to True

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2aaca49 and f3ffe3e.

📒 Files selected for processing (2)

• executorlib/task_scheduler/interactive/blockallocation.py (3 hunks)
• executorlib/task_scheduler/interactive/onetoone.py (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)

• GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-openmpi.yml)
• GitHub Check: unittest_openmpi (ubuntu-24.04-arm, 3.13)
• GitHub Check: unittest_mpich (ubuntu-latest, 3.13)
• GitHub Check: unittest_openmpi (ubuntu-22.04-arm, 3.13)
• GitHub Check: unittest_openmpi (ubuntu-latest, 3.11)
• GitHub Check: unittest_openmpi (ubuntu-latest, 3.12)
• GitHub Check: unittest_openmpi (macos-latest, 3.13)
• GitHub Check: unittest_slurm_mpich
• GitHub Check: unittest_old
• GitHub Check: notebooks_integration
• GitHub Check: notebooks
• GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-mpich.yml)
• GitHub Check: unittest_win