Opened 9 years ago

Closed 9 years ago

#4684 enhancement closed fixed (fixed)

Better API documentation for `TimeoutMixin`

Reported by: Jonathan Lange Owned by:
Priority: normal Milestone:
Component: core Keywords: documentation
Cc: Branch: branches/timeoutmixin-doc-4684
branch-diff, diff-cov, branch-cov, buildbot
Author: jml

Description

The API documentation for TimeoutMixin isn't very helpful for someone who is not familiar with the code.

In particular, resetTimeout's purpose and its behavior for edge cases are unclear.

Change History (8)

comment:1 Changed 9 years ago by Jonathan Lange

Author: jml
Branch: branches/timeoutmixin-doc-4684

(In [30136]) Branching to 'timeoutmixin-doc-4684'

comment:2 Changed 9 years ago by Jonathan Lange

(In [30137]) Improvements for TimeoutMixin documentation

refs #4684

comment:3 Changed 9 years ago by Jonathan Lange

(In [30138]) NEWS turd. refs #4684.

comment:4 Changed 9 years ago by Jonathan Lange

Keywords: review added
Owner: Jonathan Lange deleted

comment:5 Changed 9 years ago by Jean-Paul Calderone

Keywords: review removed
Owner: set to Jonathan Lange

That's all, please merge when fixed. Thanks!

comment:6 Changed 9 years ago by Jonathan Lange

(In [30139]) Conform to style guide; update copyright. refs #4684

comment:7 Changed 9 years ago by Jonathan Lange

Resolution: fixed
Status: newclosed

(In [30140]) Merge timeoutmixin-doc-4684

  • Author: jml
  • Reviewer: exarkun
  • Fixes #4684

Improve the API documentation for TimeoutMixin.

comment:8 Changed 9 years ago by <automation>

Owner: Jonathan Lange deleted
Note: See TracTickets for help on using tickets.