Opened 11 years ago

Closed 11 years ago

#3688 defect closed fixed (fixed)

memcache protocol docs incomplete for get() method

Reported by: rbd Owned by:
Priority: normal Milestone:
Component: core Keywords: memcached, documentation, get
Cc: Thijs Triemstra Branch: branches/memcache-get-docs-3688
branch-diff, diff-cov, branch-cov, buildbot
Author: exarkun

Description

The memcache protocol docs for the get() method don't mention what is returned if the key input doesn't exist.

Docs at: http://twistedmatrix.com/documents/current/api/twisted.protocols.memcache.MemCacheProtocol.html#get

They should state something like:

If the key is not found, (0, None) will be returned if withIdentifier is set to False, and (0, None, None) will be returned if withIdentifier is set to True.

(note I'm not sure about that last return value there)

Change History (6)

comment:1 Changed 11 years ago by Jean-Paul Calderone

Author: exarkun
Branch: branches/memcache-get-docs-3688

(In [26373]) Branching to 'memcache-get-docs-3688'

comment:2 Changed 11 years ago by Jean-Paul Calderone

(In [26374]) Add docs for missing value case

refs #3688

comment:3 Changed 11 years ago by Jean-Paul Calderone

Keywords: review added
Owner: Glyph deleted

comment:4 Changed 11 years ago by Thijs Triemstra

Cc: Thijs Triemstra added
Keywords: review removed
Owner: set to Jean-Paul Calderone

Looks good to me, please merge.

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

Resolution: fixed
Status: newclosed

(In [26482]) Merge memcache-get-docs-3688

Author: exarkun Reviewer: thijs Fixes: #3688

Add API documentation for the return value of the memcache client's get method in the case where the requested key is not present on the server.

comment:6 Changed 9 years ago by <automation>

Owner: Jean-Paul Calderone deleted
Note: See TracTickets for help on using tickets.