Opened 15 years ago
Closed 14 years ago
#2567 defect closed fixed (fixed)
twisted.python.log.err does not have useful docstring
| Reported by: | konrads | Owned by: | |
|---|---|---|---|
| Priority: | normal | Milestone: | |
| Component: | core | Keywords: | log, documentation |
| Cc: | Thijs Triemstra | Branch: |
branches/err-docstring-2567
branch-diff, diff-cov, branch-cov, buildbot |
| Author: | thijs |
Description
twisted.python.log.err does not have useful docstring. It does not describe what arguments _stuff and more importantly _why are used for.
This is confusing.
Change History (12)
comment:1 Changed 14 years ago by
| Cc: | Thijs Triemstra added |
|---|---|
| Keywords: | documentation added |
| Owner: | changed from Glyph to Thijs Triemstra |
| Status: | new → assigned |
comment:2 Changed 14 years ago by
| Branch: | → branches/err-docstring-2657 |
|---|
comment:3 Changed 14 years ago by
| author: | → thijs |
|---|---|
| Branch: | branches/err-docstring-2657 → branches/err-docstring-2567 |
comment:4 Changed 14 years ago by
| Keywords: | review added |
|---|---|
| Owner: | Thijs Triemstra deleted |
| Status: | assigned → new |
comment:5 follow-up: 6 Changed 14 years ago by
| Keywords: | review removed |
|---|---|
| Owner: | set to Thijs Triemstra |
The text describing _stuff should just be part of the epytext markup for that parameter. Some more text for the _why parameter would probably be helpful as well.
comment:6 Changed 14 years ago by
| Keywords: | review added |
|---|---|
| Owner: | changed from Thijs Triemstra to Jean-Paul Calderone |
Replying to exarkun:
The text describing
_stuffshould just be part of the epytext markup for that parameter. Some more text for the_whyparameter would probably be helpful as well.
I moved the text in r24636, but leave the description for _why up to you since that is what the creator of this ticket asked for (but didnt provide), I'm just as confused as him ;)
comment:8 Changed 14 years ago by
| Keywords: | review removed |
|---|---|
| Owner: | set to Jean-Paul Calderone |
Looks good; but could _stuff get a @type as long as we're at it?
Do that and merge it.
comment:11 Changed 14 years ago by
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
comment:12 Changed 11 years ago by
| Owner: | Jean-Paul Calderone deleted |
|---|
(In [24536]) Branching to 'err-docstring-2567'