[pve-devel] [PATCH pve-common v1 23/23] sectionconfig: correct example in docstring of `updateSchema()`

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

... and also reword / format the description for the `$single_class`
parameter somewhat.

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

diff --git a/src/PVE/SectionConfig.pm b/src/PVE/SectionConfig.pm
index 7c27276..77ab156 100644
--- a/src/PVE/SectionConfig.pm
+++ b/src/PVE/SectionConfig.pm
@@ -576,8 +576,8 @@ sub createSchema {
 
 =head3 $plugin->updateSchema([ $single_class, $base ])
 
-    $update_schema = PVE::Example::Plugin->update_schema($single_class, $base)
-    $update_schema = $class->updateSchema($single_class, $base)
+    $update_schema = PVE::Example::Plugin->updateSchema($single_class, $base)
+    $update_schema = $plugin->updateSchema($single_class, $base)
 
 Returns the C<L<PVE::JSONSchema>> used for I<updating> config entries of a
 I<child plugin>.
@@ -590,9 +590,9 @@ parameters of an API handler (C<PUT>).
 =item C<$single_class> (optional)
 
 Can be set to C<1> to only include properties which are defined in the returned
-hash of C<L<< options()|/$plugin->options() >>> of the plugin C<$class>.
+hash of C<L<< options()|/$plugin->options() >>> of the C<$plugin> instance.
 
-This parameter is only valid for child plugins, not the base plugin.
+B<NOTE:> This parameter is only valid for child plugins, not the base plugin.
 
 =item C<$base> (optional)
 
-- 
2.47.3



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