[pve-devel] [PATCH pve-common v1 18/23] sectionconfig: reword docs regarding property usage in isolated mode

["Max R. Carrara" <m.carrara@proxmox.com>]

In the MODES section, clarify that declaring a plugin's own properties
in `options()` is not necessary in isolated mode for visibility's
sake. The phrase "automatically added to its schema" might otherwise
not be completely clear to lesser experienced users.

Also reword a similar paragraph in the docstring for the
`properties()` method, making it a little less wordy overall.
Additionally, that paragraph mentions that a local property may be
marked as required in `options()`, which is incorrect, so get rid of
that passage of text too.

Signed-off-by: Max R. Carrara <m.carrara@proxmox.com>
---
 src/PVE/SectionConfig.pm | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/src/PVE/SectionConfig.pm b/src/PVE/SectionConfig.pm
index 6504399..6ad8772 100644
--- a/src/PVE/SectionConfig.pm
+++ b/src/PVE/SectionConfig.pm
@@ -90,7 +90,9 @@ return value of the C<L<< options()|/$plugin->options() >>> method when it's eit
 C<fixed> or stems from the global list of properties.
 
 All I<locally> defined properties of a child plugin are automatically added to
-its schema.
+its schema. This means that is is not necessary to declare the usage of a
+plugin's own properties in its own C<L<< options()|/$plugin->options() >>>
+method, unless one wants to declare it as C<fixed>.
 
 =cut
 
@@ -352,9 +354,8 @@ wishes to use them.
 
 In I<L<isolated mode|/MODES>>, the locally defined properties (those registered
 by overriding C<L<< properties()|/$plugin->properties() >>>) are automatically
-added to the plugin's schema and made C<optional> by default. Should this not be
-desired, a property may still be explicitly defined, in order to make it required
-or C<fixed> instead.
+added to the plugin's schema and made C<optional> by default. However, marking
+the property as C<fixed> must still be done via C<L<< options()|/$plugin->options() >>>.
 
 =cut
 
-- 
2.47.3



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel