From: Thomas Lamprecht <t.lamprecht@proxmox.com>
To: Proxmox Backup Server development discussion
<pbs-devel@lists.proxmox.com>,
Gabriel Goller <g.goller@proxmox.com>
Subject: Re: [pbs-devel] [PATCH proxmox] schema: removed excessive newlines in error messages
Date: Wed, 18 Oct 2023 19:22:21 +0200 [thread overview]
Message-ID: <ef964fed-a762-47de-afda-419789beccf4@proxmox.com> (raw)
In-Reply-To: <20230901081259.30375-1-g.goller@proxmox.com>
nit: s/removed/remove/, commit message should describe what they
change in the commit itself, so they make most sense if written in
the imperative.
Am 01/09/2023 um 10:12 schrieb Gabriel Goller:
> The output does not look good on console/task view when there is an
> empty line after the first error and trailing newlines after
> the last error. Removed the newlines.
I mean, as there are explicitly two newlines in a literal before
you patch it seems like somebody though it looks better that way
;-)
But sure, being more concise and providing less output, while keeping
a good readability, has definitively its merits!
The double occurrence of "error" is also something we could try to
avoid.
> Signed-off-by: Gabriel Goller <g.goller@proxmox.com>
> ---
> proxmox-schema/src/schema.rs | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/proxmox-schema/src/schema.rs b/proxmox-schema/src/schema.rs
> index f087706..596adee 100644
> --- a/proxmox-schema/src/schema.rs
> +++ b/proxmox-schema/src/schema.rs
> @@ -101,14 +101,14 @@ impl fmt::Display for ParameterError {
> let mut msg = String::new();
>
> if !self.is_empty() {
> - msg.push_str("parameter verification errors\n\n");
> + msg.push_str("parameter verification errors\n");
This is debatable, maybe we could do the following:
1. If there's exactly one parameter error collapse it to a single line, e.g.:
```
Error: parameter verification failed - 'file-name': value does not match the regex pattern
```
Or even more condensed:
```
Error: parameter 'file-name' - value does not match the regex pattern
```
2. if there are more than one error use a line by error but also use
bulletin point to keep a higher readability, e.g.:
```
Error: parameter verification failed:
- 'file-name': value does not match the regex pattern
- 'some-number': value is not in range X to Y
- 'foo-bar': value is to common
```
The only thing, from top of my head, speaking against doing 1. at all would
be that it's making parsing a bit harder, but tbh., we never guaranteed
error message stability, and if one depends on such stuff they should use
the API – so not seeing that as a blocker.
What do you think?
> }
>
> for (name, err) in self.error_list.iter() {
> let _ = writeln!(msg, "parameter '{}': {}", name, err);
> }
>
> - write!(f, "{}", msg)
> + write!(f, "{}", msg.trim())
this I'm fine with doing unconditionally.
> }
> }
>
next prev parent reply other threads:[~2023-10-18 17:22 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-01 8:12 Gabriel Goller
2023-10-11 11:06 ` Gabriel Goller
2023-10-18 17:22 ` Thomas Lamprecht [this message]
2023-10-23 7:51 ` Gabriel Goller
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=ef964fed-a762-47de-afda-419789beccf4@proxmox.com \
--to=t.lamprecht@proxmox.com \
--cc=g.goller@proxmox.com \
--cc=pbs-devel@lists.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox