jamulus icon indicating copy to clipboard operation
jamulus copied to clipboard

Logging: Make log messages consistent

Open hoffie opened this issue 4 years ago • 3 comments

Log messages (especially from src/main.cpp) should be checked for consistency.

  • Uppercase/lowercase (as suggested by @drummer1154 in #1284)
  • Trailing dots
  • Indentation
  • Leading characters such as -

The rules (e.g. leading - for command line flag-related output?) should be documented somewhere.

hoffie avatar Apr 07 '21 20:04 hoffie

Of course I am willing to contribute to consistent user messages.

But please look at https://github.com/jamulussoftware/jamulus/issues/1289#issuecomment-818306326

My perception is that user input is not very welcome - developer input takes precedence.

drummer1154 avatar Apr 12 '21 23:04 drummer1154

@hoffie I don't think this is a good first issue since it needs discussion first. Therefore I've removed the good first issue label.

If we stay to the current style "options" would have a - in front.

I think @pgScorpio (sorry for another ping here...) did a first step towards simplification and unification here: https://github.com/jamulussoftware/jamulus/pull/2598

ann0see avatar Apr 22 '22 19:04 ann0see

@ann0see

I think @pgScorpio (sorry for another ping here...) did a first step towards simplification and unification here: #2598

No problem ;=)

Yes that is probably a first step, but I agree that maybe the message texts could be somewhat more consistent too.

pgScorpio avatar Apr 22 '22 23:04 pgScorpio