Closed Bug 874918 Opened 11 years ago Closed 8 years ago

Add useful docstrings to our tests

Categories

(Socorro :: General, task)

Product:
Socorro
Component:
General
Platform:
x86_64
Linux
Type:
task
Priority:
Not set
Severity:
normal

Tracking

(Not tracked)

Status:
RESOLVED INVALID

People

(Reporter: selenamarie, Unassigned)

References

Details

We don't have docstrings for most of our test suite. 

When running tests, we see: 
test_generate_signature_13_replace_address_and_colon (socorro.unittest.processor.testSignatureUtilities.TestCase) ... ok

Instead of: 
this test also exercises the retry but with a different internal exception ... ok

We could use: 
* A style guide for docstrings in tests
* A series of bugs that address updating these in groups
What is the best approach to reach this?
Bug too broad. Doc strings are only needed/useful if they're needed/useful.
Status: NEW → RESOLVED
Closed: 8 years ago
Resolution: --- → INVALID
You need to log in before you can comment on or make changes to this bug.