sphinx.ext.napoleon.docstring.Deque

class documentation

class Deque(collections.deque): (source)

View In Hierarchy

A subclass of deque that mimics ``pockets.iterators.modify_iter``. The `.Deque.get` and `.Deque.next` methods are added.

Method get Return the nth element of the stack, or ``self.sentinel`` if n is greater than the stack size.
Method next Undocumented
Class Variable sentinel Undocumented
def get(self, n): (source)

Return the nth element of the stack, or ``self.sentinel`` if n is greater than the stack size.

Parameters
n:intUndocumented
Returns
AnyUndocumented
def next(self): (source)

Undocumented

Returns
AnyUndocumented
sentinel = (source)

Undocumented