HTTPAuthSessionWrapper.getChildWithDefault claims to return a deferred but doesn't
Open
Nobody has claimed this yet.
bug
documentation
new
priority-normal
web
- Dominant language
- Python
- Stars
- 6k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 10
Description
 |
@lvh reported |
|---|---|
| Trac ID | trac#6601 |
| Type | defect |
| Created | 2013-06-28 08:13:22Z |
The docstring claims to return a deferred. That's obviously wrong: IResource.getChildWithDefault doesn't let you do that. Instead, it returns a DeferredResource, which is a related, but different beast :)
Attachments:
- 6601.patch (685 bytes) - added by Saurabh on 2013-10-08 14:28:37Z -
Searchable metadata
trac-id__6601 6601
type__defect defect
reporter__lvh lvh
priority__normal normal
milestone__
branch__
branch_author__
status__new new
resolution__None None
component__web web
keywords__documentation documentation
time__1372407202000000 1372407202000000
changetime__1383409340000000 1383409340000000
version__None None
owner__
cc__jknight
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open twisted/web/_auth/wrapper.py around line 135 and inspect the HTTPAuthSessionWrapper.getChildWithDefault docstring alongside IResource.getChildWithDefault. Update the return description to identify DeferredResource accurately, then verify the documentation change against the surrounding API wording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- web-dev
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100