Skip to content

Commit

Permalink
squash: add more warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
happz committed Jan 5, 2024
1 parent 276f4a3 commit 750c502
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/plugins.rst.j2
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,18 @@
{{ PLUGIN_ID }}
{{ '^' * (PLUGIN_ID | length)}}

{#
TODO: once we start getting reviewed and polished plugins, drop the warning
for those that would be done and ready. Probably with some temporary list
to which we would add their names.
#}
.. warning::

Please, be aware that the documentation below is a work in progress. We are
working on fixing it, adding missing bits and generally making it better.
Also, it was originaly used for command line help only, therefore the
formatting is often suboptional.

{% if PLUGIN.__doc__ %}
{{ PLUGIN.__doc__ | dedent | strip }}
{% endif %}
Expand Down

0 comments on commit 750c502

Please sign in to comment.