doc: Add a tutorial how to write plugins #1034
Conversation
jan-kolarik
force-pushed
the
jkolarik/plugins-docs
branch
from
a76e721 to
a24e098
Compare
jan-kolarik
force-pushed
the
jkolarik/plugins-docs
branch
2 times, most recently
from
cf42008 to
731b72b
Compare
| constexpr const char * attrs[]{"author.name", "author.email", "description", nullptr}; | ||
| constexpr const char * attrs_value[]{"Fred Fedora", "[email protected]", "Plugin description."}; | ||
|
|
||
| class TemplateCmdPlugin : public IPlugin { |
There was a problem hiding this comment.
I would suggest to add a comment for the class and each of its methods, including inheritance.
There was a problem hiding this comment.
May I ask you to add class documentation for class IPlugin?
There was a problem hiding this comment.
I've provided some additional brief docstrings for the IPlugin classes in dnf5 and libdnf5 namespaces. Please let me know if more detailed information would be appropriate.
| [main] | ||
| name = template | ||
| enabled = yes | ||
| version = 1.0.1 |
There was a problem hiding this comment.
Is configuration file mandatory? Is any of the keys mandatory? How the version key is used? May be I overlooked something and it is described in documentation somewhere.
There was a problem hiding this comment.
I've tried to make it more explicit in the docs text and I've also added a comment into the example configuration file.
And some final docs fixups.
jan-kolarik
force-pushed
the
jkolarik/plugins-docs
branch
from
731b72b to
0cca56f
Compare
|
I've tried to address all comments. Please let me know if I've missed anything. |
|
LGTM |
Documentation updates cover the following aspects:
Closes #287.