search

picmi-standard / picmi

Standard input format for Particle-In-Cell codes
https://picmi.readthedocs.io
Other
35 stars 25 forks source link

Added metaclass to manipulate the class doc strings #79

Closed dpgrote closed 2 years ago

dpgrote commented 2 years ago

This PR defines the meta class _DocumentedMetaClass that is used to manipulate the class doc strings. This manipulation is a convenience that combines the doc strings of the picmistandard classes with any additional doc strings of the implementation classes. This makes the full documentation of the class available to the user.