Apply textwrap.dedent() to task docstrings

[jlaportebot]

When using the @task decorator, task documentation can be passed via the function docstring. However, the indentation from the function body was preserved in the UI, making the documentation look unattractive.

This change applies textwrap.dedent() to the docstring before setting it as doc_md, which removes the common leading whitespace from each line.

Fixes #66477

Changes

• Modified to apply to the function docstring when setting
• Added comprehensive tests in to verify:
  • Docstrings are properly dedented
  • Explicit doc_md is not overridden by function docstring
  • Complex indentation is handled correctly
  • Tasks without docstrings have no doc_md

Testing

Added 4 test cases:

1. • Verifies basic dedent functionality
2. • Verifies explicit doc_md is not overridden
3. • Verifies complex indentation is handled
4. • Verifies tasks without docstrings have no doc_md

[SameerMesiah97]

Just one missing test case. Let's wait for CI to run.

[SameerMesiah97]

Test coverage is solid. One additional edge case that may be worth covering is an already-dedented docstring to verify the transformation is effectively a no-op when no common indentation exists. Right now the tests only cover indented inputs.

[jlaportebot]

Good catch on the test — the CI failure shows that textwrap.dedent() preserves leading/trailing newlines from docstrings. I've updated the code to use textwrap.dedent(...).strip() which removes the leading newline that Python docstrings typically have. This should make the tests pass on the next CI run. Pushed the fix in commit 5c7ea04.

[jlaportebot]

Thanks for the suggestion @SameerMesiah97! I've added a test case for already-dedented docstrings in the latest push (a7d25d3). It verifies that textwrap.dedent is effectively a no-op when there's no common leading whitespace, and that .strip() only removes surrounding whitespace. Let me know if you'd like any additional edge cases covered.

[jlaportebot]

Thanks @SameerMesiah97 for the suggestion! I've already added the already-dedented test case in a previous commit (test_task_docstring_already_dedented). I've also just pushed a fix for the CI failures — the Static Checks job was failing due to: 1. Unused pytest import in the test file (F401) 2. Docstring formatting issue (""" My task description. """ had extra spaces that ruff-format flagged). Both are now fixed. Waiting for CI to re-run.

[jlaportebot]

Thanks @SameerMesiah97 — good point about the no-op dedent test. I'll add a test case for an already-dedented docstring to confirm returns the string unchanged when there's no common leading whitespace.