Vega strike Python Modules doc  0.5.1
Documentation of the " Modules " folder of Vega strike
 All Data Structures Namespaces Files Functions Variables
_TestClass Class Reference

Public Member Functions

def __init__
 
def square
 
def get
 

Data Fields

 val
 

Detailed Description

A pointless class, for sanity-checking of docstring testing.

Methods:
    square()
    get()

>>> _TestClass(13).get() + _TestClass(-12).get()
1
>>> hex(_TestClass(13).square().get())
'0xa9'

Definition at line 1115 of file doctest.py.

Constructor & Destructor Documentation

def __init__ (   self,
  val 
)
val -> _TestClass object with associated value val.

>>> t = _TestClass(123)
>>> print t.get()
123

Definition at line 1129 of file doctest.py.

1130  def __init__(self, val):
1131  """val -> _TestClass object with associated value val.
1132 
1133  >>> t = _TestClass(123)
1134  >>> print t.get()
1135  123
1136  """
1138  self.val = val

Member Function Documentation

def get (   self)
get() -> return TestClass's associated value.

>>> x = _TestClass(-42)
>>> print x.get()
-42

Definition at line 1149 of file doctest.py.

References _TestClass.val.

1150  def get(self):
1151  """get() -> return TestClass's associated value.
1152 
1153  >>> x = _TestClass(-42)
1154  >>> print x.get()
1155  -42
1156  """
1157 
1158  return self.val
def square (   self)
square() -> square TestClass's associated value

>>> _TestClass(13).square().get()
169

Definition at line 1139 of file doctest.py.

References _TestClass.val.

1140  def square(self):
1141  """square() -> square TestClass's associated value
1142 
1143  >>> _TestClass(13).square().get()
1144  169
1145  """
1146 
1147  self.val = self.val ** 2
1148  return self

Field Documentation

val

Definition at line 1137 of file doctest.py.


The documentation for this class was generated from the following file: