Opened 16 years ago

Closed 13 years ago

#1882 task closed fixed (fixed)

update the coding standard to require docstrings for all new unit test methods

Reported by: radix Owned by:
Priority: high Milestone:
Component: core Keywords: documentation
Cc: Thijs Triemstra Branch: branches/tests-docstring-standard-1882
branch-diff, diff-cov, branch-cov, buildbot
Author: thijs

Description

All unit test methods should have docstrings specifying at a high level the intent of the test. That is, a description that users of the method would understand.

Change History (8)

comment:1 Changed 16 years ago by jknight

Prerequisite: make trial not output the docstring instead of the test name?

comment:2 Changed 15 years ago by Glyph

Priority: normalhigh

comment:3 Changed 13 years ago by Thijs Triemstra

Cc: Thijs Triemstra added
Keywords: documentation added
Owner: changed from Glyph to Thijs Triemstra
Status: newassigned

Both the [source:trunk/doc/development/policy/test-standard.xhtml test] and [source:trunk/doc/development/policy/coding-standard.xhtml coding] standard docs need an update.

comment:4 Changed 13 years ago by Thijs Triemstra

author: thijs
Branch: branches/tests-docstring-standard-1882

(In [24557]) Branching to 'tests-docstring-standard-1882'

comment:5 Changed 13 years ago by Thijs Triemstra

Keywords: review added
Owner: Thijs Triemstra deleted
Status: assignednew

comment:6 Changed 13 years ago by washort

Keywords: review removed
Owner: set to Thijs Triemstra

I guess that works. merge.

comment:7 Changed 13 years ago by Thijs Triemstra

Resolution: fixed
Status: newclosed

(In [24613]) Merge tests-docstring-standard-1882: updated the coding standard to require docstrings for all new unit test methods.

Author: thijs Reviewer: washort Fixes: #1882

comment:8 Changed 11 years ago by <automation>

Owner: Thijs Triemstra deleted
Note: See TracTickets for help on using tickets.