Package Camelot :: Package camelot :: Package core :: Package document |
[frames] | no frames]

# Package document

source code

Decorators to enhance the docstrings of classes

Functions
documented_entity() Class decorator to append an image of the default view for an entity to an entity class. The image can be generated by using the testing framework to create images of all default views in an application | source code
documented_type() Class decorator to append an image of the default editor of a field type to the docstring of the type | source code

Variables
| __package__ = `None` hash(x)

Function Details

### documented_entity() | source code
Class decorator to append an image of the default view for an entity to an entity class. The image can be generated by using the testing framework to create images of all default views in an application
    @documented_entity()
    class Movie(Entity):
      '''A movie as played in the theater'''
      title = Field(Unicode(50))
The resulting docstring of the Movie entity will be
    '''A movie as played in the theater

    image ../_static/entityviews/new_view_movie.png
    '''