From: Dietmar Maurer <dietmar@proxmox.com>
To: pve-devel@lists.proxmox.com, w.bumiller@proxmox.com
Subject: Re: [RFC proxmox] schema: extend SchemaPropertyEntry to include property description
Date: Mon, 9 Feb 2026 08:53:46 +0000 [thread overview]
Message-ID: <mleximuw.2w78iwctyb600@proxmox.com> (raw)
In-Reply-To: <20260129165023.4170492-1-dietmar@proxmox.com>
Answering myself, this introduces serious problems:
- Dual Description Ambiguity
It's unclear which one to display by default. Always showing both is
redundant in most cases since they often contain the same text.
The documentation generator (format.rs) now needs to make decisions
about precedence that weren't necessary before.
- Macro Syntax Confusion
The current #[api] macro doesn't clearly distinguish between:
- type-description: describing the type itself
- property-description: describing this specific usage of the type
- Rare Use Case
The scenario where we actually need different descriptions for the same
type used in different properties is uncommon. In the rare cases where
this is needed, defining two separate schema types is a simpler and
more explicit solution.
So I guess it is not worth to implement it.
- Dietmar
prev parent reply other threads:[~2026-02-09 8:54 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-29 16:50 Dietmar Maurer
2026-02-09 8:53 ` Dietmar Maurer [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=mleximuw.2w78iwctyb600@proxmox.com \
--to=dietmar@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
--cc=w.bumiller@proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.