Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Log Message Formatting #178

Open
seisatsu opened this issue Oct 4, 2017 · 1 comment
Open

Log Message Formatting #178

seisatsu opened this issue Oct 4, 2017 · 1 comment
Assignees
Labels

Comments

@seisatsu
Copy link
Member

seisatsu commented Oct 4, 2017

  • Phrases and sentences in log messages start with lowercase letters and do not end with a period.
  • Error and warning messages always reveal the name and class of the method or function that produced the warning, while info messages reveal the name of the action that was taken. Any identifying information should also be given.
@seisatsu seisatsu changed the title Warnings and Errors ormatting Log Message Formatting Oct 4, 2017
@seisatsu seisatsu self-assigned this Oct 4, 2017
@pmer
Copy link
Member

pmer commented Oct 4, 2017

At least when the log level is set to “halt,” log messages serve as assertions that cause the program to die. While running your program in debug mode, assertions like that often produce a backtrace to help developers find the source of their bug.

@seisatsu seisatsu added style and removed refactor labels Oct 5, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants