You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
New-style properties (declared in class body) can have documentation attached to them whereas old-style properties (declared in __init__) did not. This allows for automation of documentation generation for those fields by defining docstrings and setting the __doc__ attribute as appropriate. A few classes have already been updated. In addition there are attributes of the property (like its value_type and inverse_of) which are now accessible for documentation generation after module load: these should be added to the doc string.
Example of a new-style properties:
classClock(DataObject):
hour=DatatypeProperty() # <--- new-style property''' The hour of the clock '''# <-- documentation for the propertyminute=DatatypeProperty()
''' The minute of the :py:attr:`hour` of the clock '''maker=ObjectProperty(value_type=ClockManufacturer) # undocumented
It may not be clear what documentation is appropriate to each attribute, but the first task is just to identify which attributes are lacking documentation.
The text was updated successfully, but these errors were encountered:
- Including empty Git repo creation
- Making optimizations in various places. Adding docstrings (#350)
- Making it possible to do RealSimpleProperty decls in class body.
This was added now mostly for documentation purposes, but also because
eventually, we'll want to add these relationships to the graph (#351)
- Reordering operations to avoid unnecessary work
- Using namedtuple for Statement impl
- Removing unneeded imports in __init__.py
- Removing automodules in PyOpenWorm docstring -- apidoc will handle these
- Adding an excepthook to filter out import_override frames
- Making DataObjectTest backwards compatible with 2.7
- Upgrading numpydoc and updating documentation
- Enabling "related topics" in docs html sidebar
- Enabling warnings
- Adding arg for ContextualizableList decontextualize init
- Changing to "pow.conf" for default config file name. Adding add_graph test
- Putting imports in a named context
- Adding base directory for translation in insert_worm.py: Makes things
more portable
New-style properties (declared in class body) can have documentation attached to them whereas old-style properties (declared in
__init__
) did not. This allows for automation of documentation generation for those fields by defining docstrings and setting the__doc__
attribute as appropriate. A few classes have already been updated. In addition there are attributes of the property (like itsvalue_type
andinverse_of
) which are now accessible for documentation generation after module load: these should be added to the doc string.Example of a new-style properties:
It may not be clear what documentation is appropriate to each attribute, but the first task is just to identify which attributes are lacking documentation.
The text was updated successfully, but these errors were encountered: