Shorten no ASIO error message by ann0see · Pull Request #1569 · jamulussoftware/jamulus

ann0see · 2021-04-27T20:22:28Z

Multiple error messages in Jamulus are rather lengthy and probably not read by users. This changes one of the first messages a new and inexperienced user might see.

See: #1568 (comment)

windows/sound.cpp

hoffie · 2021-04-27T20:45:17Z

windows/sound.cpp

-            "is recommended) or you might want to use alternative drivers like "
-            "the ASIO4All driver." ) );
+        throw CGenErr ( "<b>" + tr ( "No audio device with ASIO driver detected" ) + "</b><br><br>" +
+            tr ( "To use " ) + APP_NAME + tr ( ", you need to install an ASIO driver first. "


I wonder if this construct makes translations harder. Previously, it was just an article ("The"), now it's an infinitive construction. This works for German, but I'm not sure about other languages.
The following may be more flexible, but I'm not sure if it's better overall. Maybe someone else can comment as well. I think @pljones once mentioned this pattern.

QString ( tr ( "The %1 software requires..." ) ).arg ( APP_NAME )

(Hrm, I'm pretty sure I had already typed this once, but somehow it got lost!?)

Ah yes - this format does make it clearer for the translators. I'd forgotten about it, too! This way, they get more of the context, it's not so broken up, and thus also more allows flexibility in how it's translated.

pljones · 2021-04-27T20:45:44Z

windows/sound.cpp

-            "required. Either your sound card has a native ASIO driver (which "
-            "is recommended) or you might want to use alternative drivers like "
-            "the ASIO4All driver." ) );
+        throw CGenErr ( "<b>" + tr ( "No audio device with ASIO driver detected" ) + "</b><br><br>" +


I prefer the original No ASIO audio device (driver) found., to be honest, for the first line. (It's got a full stop, too :) .) Maybe remove the () around driver, though...

Yes, this is shorter but maybe not that clear for a new user who doesn’t know anything about ASIO.

Tagging @mulyaj here who proposed this exact wording.

Whether they know about ASIO doesn't make one preferable to the other, as both describe the problem as being with something to do with ASIO. The point is, it's not the device, it's the _driver. Your phrasing changes the emphasis. Indeed, the original (with the ()) had it wrong, in my view. But it had a full stop...

My initial thought was "Install an ASIO driver to use Jamulus" which empathises the solution rather then the error. I think muljay didn’t like it because it doesn’t clearly explain the error. Not sure if that’s good/Bad in an UX point of view.

Your phrasing changes the emphasis

That's right, I agree with @pljones here.

pljones · 2021-04-27T20:48:36Z

windows/sound.cpp

-            "is recommended) or you might want to use alternative drivers like "
-            "the ASIO4All driver." ) );
+        throw CGenErr ( "<b>" + tr ( "No audio device with ASIO driver detected" ) + "</b><br><br>" +
+            tr ( "To use " ) + APP_NAME + tr ( ", you need to install an ASIO driver first. "


I think the following is an easier read:

tr ( "You need to install an ASIO driver before running" ) + " " APP_NAME + ". "

Edit: or, indeed, per @hoffie's comment, using QString().arg().

Instead of
You need to install an ASIO driver ....

Perhaps we can use
Please install an ASIO driver ...

You need to, and moreso, require can be read as demanding to the user.

True. "Thou shalt ... else ..!" might have been going too far, so I held back from that... :)

Multiple error messages in Jamulus are rather lengthy and probably not read by users. This changes one of the first messages a new and inexperienced user might see. See: jamulussoftware#1568 (comment)

pljones · 2021-04-29T18:53:25Z

windows/sound.cpp

+        throw CGenErr ( "<b>" + tr ( "No ASIO audio device driver found." ) + "</b><br><br>" +
+            QString ( tr ( "Please install an ASIO driver before running %1. "
+            "If you own a device with ASIO support, install its official ASIO driver. "
+            "If not, you'll need to use a driver like ASIO4ALL." ) ).arg ( APP_NAME ) );


Approving but I wonder if this should say "...a universal driver like..."?

Yes. That's better.

ann0see · 2021-04-29T19:13:59Z

If everybody is ok with it, I'd merge this PR. The error could be more user friendly by adding a "more information" button to open jamulus.io but that's out of scope here (and not yet possible).

Edit: Also changed "use" to download and install.

mulyaj

Looks good to me!

ann0see force-pushed the errorMsg branch 3 times, most recently from 01dbf8e to 1f9f779 Compare April 27, 2021 20:28

hoffie reviewed Apr 27, 2021

View reviewed changes

windows/sound.cpp Outdated Show resolved Hide resolved

ann0see force-pushed the errorMsg branch from 37e5859 to 146e706 Compare April 27, 2021 20:31

hoffie reviewed Apr 27, 2021

View reviewed changes

pljones reviewed Apr 27, 2021

View reviewed changes

ann0see force-pushed the errorMsg branch from 146e706 to a26419c Compare April 29, 2021 17:05

Shorten no ASIO error message

97dc48d

Multiple error messages in Jamulus are rather lengthy and probably not read by users. This changes one of the first messages a new and inexperienced user might see. See: jamulussoftware#1568 (comment)

ann0see force-pushed the errorMsg branch from a26419c to 97dc48d Compare April 29, 2021 17:16

ann0see requested review from hoffie, mulyaj and pljones April 29, 2021 17:50

pljones reviewed Apr 29, 2021

View reviewed changes

pljones approved these changes Apr 29, 2021

View reviewed changes

hoffie approved these changes Apr 29, 2021

View reviewed changes

Clarify that ASIO4ALL is universal

2e8fb71

Clarify error message

de40db5

hoffie approved these changes Apr 29, 2021

View reviewed changes

mulyaj approved these changes Apr 29, 2021

View reviewed changes

ann0see merged commit 6560b68 into jamulussoftware:master Apr 29, 2021

ann0see deleted the errorMsg branch April 29, 2021 19:42

pljones added this to the Release 3.8.0 milestone Feb 19, 2022

Comments

Conversation

ann0see commented Apr 27, 2021

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pljones Apr 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pljones Apr 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ann0see Apr 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pljones Apr 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pljones Apr 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ann0see commented Apr 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mulyaj left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

pljones Apr 27, 2021 •

edited

Loading

pljones Apr 27, 2021 •

edited

Loading

ann0see Apr 29, 2021 •

edited

Loading

pljones Apr 27, 2021 •

edited

Loading

pljones Apr 29, 2021 •

edited

Loading

ann0see commented Apr 29, 2021 •

edited

Loading