Skip to content

Remove redundant docstrings from test classes#1897

Merged
nathanjmcdougall merged 5 commits into
mainfrom
copilot/remove-docstrings-from-test-classes
Apr 9, 2026
Merged

Remove redundant docstrings from test classes#1897
nathanjmcdougall merged 5 commits into
mainfrom
copilot/remove-docstrings-from-test-classes

Conversation

Copilot AI commented Apr 8, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor
  • Remove redundant docstrings from 5 test classes across 5 files:
    • TestDeptryTool — test_deptry.py
    • TestAddRepoPipeweld — test_hooks.py
    • TestLiterals — test_yaml_io_.py
    • TestDoubleNesting — test_func.py
    • TestMigration — test_core_tool.py
  • Restore informative docstrings on TestAllBadgesMarkdownValid and TestIconFallbackIntegration
  • Update usethis-python-test skill (v1.3 → v1.4): refine convention — redundant docstrings should be omitted, informative ones are appropriate
  • Fix markdownlint: remove extra blank line in SKILL.md
  • All static checks pass

Resolves #1896

Copilot AI linked an issue Apr 8, 2026 that may be closed by this pull request
Lesson: Test classes should not have docstrings #1896
Closed
@nathanjmcdougall
remove docstrings from test classes in test files
bd23690 
Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/61fa31b6-ac9b-4a7c-bd46-f528bb0630aa

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot AI changed the title [WIP] Remove unnecessary docstrings from test classes Remove docstrings from test classes Apr 8, 2026
Copilot AI requested a review from nathanjmcdougall April 8, 2026 11:31
@nathanjmcdougall nathanjmcdougall marked this pull request as ready for review April 8, 2026 19:46
nathanjmcdougall
nathanjmcdougall requested changes Apr 8, 2026
View reviewed changes
Comment thread tests/usethis/_core/test_core_badge.py
Comment thread tests/usethis/test_console.py
@nathanjmcdougall
restore docstrings on TestAllBadgesMarkdownValid and TestIconFallback…
3c389a4 
…Integration; refine skill guidance

Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/44fe822c-6d64-4f38-8f80-cbbf2c0d44b3

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
@codspeed-hq

codspeed-hq Bot commented Apr 8, 2026 •
edited
Loading

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 3 untouched benchmarks

Comparing copilot/remove-docstrings-from-test-classes (5a42800) with main (5f17d9a)1

Open in CodSpeed

Footnotes

  1. No successful run was found on main (5e08de1) during the generation of this report, so 5f17d9a was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

Copilot AI changed the title Remove docstrings from test classes Remove redundant docstrings from test classes Apr 8, 2026
Copilot AI requested a review from nathanjmcdougall April 8, 2026 19:53
@nathanjmcdougall

nathanjmcdougall commented Apr 9, 2026

Copy link
Copy Markdown
Collaborator

@copilot please pass static checks

Copilot AI commented Apr 9, 2026

Copy link
Copy Markdown
Contributor Author

@copilot please pass static checks

Fixed in 5a42800 — markdownlint auto-fixed an extra blank line in the updated SKILL.md. All static checks now pass.

Copilot AI requested a review from nathanjmcdougall April 9, 2026 01:23
@codecov

codecov Bot commented Apr 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@nathanjmcdougall nathanjmcdougall merged commit 600a402 into main Apr 9, 2026
20 checks passed
@nathanjmcdougall nathanjmcdougall deleted the copilot/remove-docstrings-from-test-classes branch April 9, 2026 01:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nathanjmcdougall nathanjmcdougall Awaiting requested review from nathanjmcdougall

Assignees

@nathanjmcdougall nathanjmcdougall

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Lesson: Test classes should not have docstrings

2 participants

@nathanjmcdougall