Module: quantity

Example Google style docstrings.

This module demonstrates documentation as specified by the Google Python Style Guide. Docstrings may extend over multiple lines. Sections are created with a section header and a colon followed by a block of indented text.

Example:

Examples can be given using either the Example or Examples sections. Sections support any reStructuredText formatting, including literal blocks:

$ python example_google.py

Section breaks are created by resuming unindented text. Section breaks are also implicitly created anytime a new section starts.

Attributes:

module_level_variable1 (int): Module level variables may be documented in

either the Attributes section of the module docstring, or in an inline docstring immediately following the variable.

Either form is acceptable, but the two should not be mixed. Choose one convention to document module level variables and be consistent with it.

class Angle(value, units='deg', copy=True, name=None)

Bases: asterism.core.observables.quantity.Quantity

Attributes

allowed_units
deg
name
rad
shape
to_deg
to_rad
units
values

Methods

view()

deg

rad

to_deg

to_rad

class Distance(values, units=None, allowed_units=[], copy=True, name=None)

Bases: asterism.core.observables.quantity.Quantity

Attributes

allowed_units
name
shape
units
values

Methods

view()

class Pixel(value, units='deg', copy=True)

Bases: asterism.core.observables.quantity.Quantity

Attributes

allowed_units
name
shape
units
values

Methods

view()

class Quantity(values, units=None, allowed_units=[], copy=True, name=None)

Bases: object

Attributes

allowed_units
name
shape
units
values

Methods

view()

allowed_units

name

shape

units

values

view()