Opened 2 years ago

Closed 2 years ago

#8024 enhancement closed fixed (fixed)

Doc: DeferredSemaphore correction

Reported by: Anthony Martinez Owned by: Anthony Martinez
Priority: low Milestone:
Component: core Keywords: doc
Cc: Branch: branches/deferredsemaphore-docs-8024
branch-diff, diff-cov, branch-cov, buildbot
Author: adiroiban

Description

Now the documentation for twisted.defer.DeferredSemaphore refers to the correct instance attributes.

Attachments (1)

8024-deferredsemaphore-docs.patch (1.3 KB) - added by Anthony Martinez 2 years ago.

Download all attachments as: .zip

Change History (7)

Changed 2 years ago by Anthony Martinez

comment:1 Changed 2 years ago by Anthony Martinez

Keywords: review added

comment:2 Changed 2 years ago by Adi Roiban

Author: adiroiban
Branch: branches/deferredsemaphore-docs-8024

(In [45701]) Branching to deferredsemaphore-docs-8024.

comment:3 Changed 2 years ago by Adi Roiban

Keywords: review removed
Owner: changed from habnabit to Anthony Martinez

Changes look good. Thanks!

Just a minor comment regarding the release notes fragment.

I think that twisted.defer.DeferredSemaphore should be twisted.internet.defer.DeferredSemaphore

Maybe instead of the refers to the correct instance attributes. we should have

Now the documentation for twisted.internet.defer.DeferredSemaphore describes to actual usage for limit and tokens instance attributes.

What do you think?


As soon as the test will pass I will look into updating the news file and merging this.

Many thanks for your contribution!

comment:4 Changed 2 years ago by Anthony Martinez

You're absolutely right about twisted.internet.defer and I'm okay with the release-note change provided it's corrected to "describes the actual usage". :)

comment:5 Changed 2 years ago by Adi Roiban

True. Will update and merge.

It is past midnight here so I will do the merge tomorrow, just to make sure I am not doing anything stupid.

Thanks!

comment:6 Changed 2 years ago by Adi Roiban

Resolution: fixed
Status: newclosed

(In [45710]) Merge deferredsemaphore-docs-8024: Fix t.i.defer.DeferredSemaphore docstring.

Author: fr-anthony Reviewer: adiroiban Fixes: #8024

Note: See TracTickets for help on using tickets.