Changes between Version 23 and Version 24 of DevGuide


Ignore:
Timestamp:
Dec 15, 2016, 1:43:38 AM (6 years ago)
Author:
Ryan J Ollos
Comment:

Document standardized way of documenting required and optional components, refs #11690.

Legend:

Unmodified
Added
Removed
Modified
  • DevGuide

    v23 v24  
    102102}}}
    103103
     104== Documenting required and optional components
     105
     106The docstring for a Component class is displayed as the Component description on the plugin admin panel.
     107It is recommended that the description be prefixed with `[required]` or `[optional]`, to guide end-users in
     108enabling the proper Components. The `[extra]` descriptor can also used for features that have specialized or narrow use-cases.
     109
    104110== Publishing Packages to PyPI
    105111