improved code documentation

This commit is contained in:
MinchinWeb 2021-05-09 13:49:35 -06:00
parent 2a70636b4d
commit f22d985330
3 changed files with 68 additions and 10 deletions

View file

@ -4,7 +4,14 @@
# License: https://www.gnu.org/licenses/gpl-3.0.html
"""
Exporter for testing and experimentation purposes
Exporter for testing and experimentation purposes.
The presence of this plugin is also used as a "switch" by the test suite to
decide on whether or not to run the "vanilla" test suite, or the test suite
for external plugins.
The `export_entry` and `export_journal` methods are both purposely not
implemented to confirm behavior on plugins that don't implement them.
"""
from jrnl.plugins.base import BaseExporter