Opened 6 years ago

Closed 6 years ago

#6444 defect closed fixed (fixed)

Incorrect docstrings in test_usage.py

Reported by: Stephen Solis Owned by: Stephen Solis
Priority: low Milestone:
Component: core Keywords:
Cc: Branch:
Author:

Description (last modified by Jean-Paul Calderone)

Docstrings in twisted/test/test_usage.py for ParseCorrectnessTest, TypedTestCase, and WrongTypedTestCase indicate that Options.parseArgs is being tested, but really Options.parseOptions is being tested.

Attachments (4)

ticket6444_v1.diff​ (1.0 KB) - added by Stephen Solis 6 years ago.
ticket6444_v1.patch​ (1.0 KB) - added by Stephen Solis 6 years ago.
change extension to .patch (d'oh!)
ticket6444_v2.patch​ (995 bytes) - added by Stephen Solis 6 years ago.
Added epytext link markup
6444v3.patch​ (6.5 KB) - added by Stephen Solis 6 years ago.
Addressed review suggestions

Download all attachments as: .zip

Change History (10)

Changed 6 years ago by Stephen Solis

Attachment: ticket6444_v1.diff​ added

comment:1 Changed 6 years ago by Stephen Solis

Keywords: review added
Owner: Stephen Solis deleted

Changed 6 years ago by Stephen Solis

Attachment: ticket6444_v1.patch​ added

change extension to .patch (d'oh!)

comment:2 Changed 6 years ago by Jean-Paul Calderone

Description: modified (diff)
Summary: Incorrect comments in test_usage.py → Incorrect docstrings in test_usage.py

Changed 6 years ago by Stephen Solis

Attachment: ticket6444_v2.patch​ added

Added epytext link markup

comment:3 Changed 6 years ago by Richard Wall

Keywords: review removed
Owner: set to Stephen Solis

Thanks stephsolis. Well spotted.

  1. Your patch has trailing whitespace
  2. Missing news file
  3. Why don't you also add some of the missing docstrings eg to SubcommandTestCase and HelpStringTest etc

Please answer or address the points above and submit another patch for review.

Changed 6 years ago by Stephen Solis

Attachment: 6444v3.patch​ added

Addressed review suggestions

comment:4 Changed 6 years ago by Stephen Solis

Keywords: review added
Owner: Stephen Solis deleted

comment:5 Changed 6 years ago by Richard Wall

Keywords: review removed
Owner: set to Stephen Solis

Thanks stephsolis.

The latest patch looks fine.

But I think on second thoughts I'll change the news file to a .misc - changes to test docstrings don't really need to show up in the next release notes.

Then I'll apply it to trunk.

-RichardW.

comment:6 Changed 6 years ago by Richard Wall

Resolution: → fixed
Status: new → closed

(In [38347]) Apply 6444v3.patch: Improvments to the test_usage docstrings

Author: stephsolis Reviewer: rwall Fixes: #6444

Improvments to the test_usage docstrings.

Note: See TracTickets for help on using tickets.