jazzdotdev / jazzdotdev/jazz

change println!() messages to fitting log message

Open
#151 0 comments 0 reactions 0 assignees View on GitHub
component/lib focus/sanity model/change progress/0.0 size/0.25 track/ready value/0.75
Dominant language
Rust
Stars
147
Forks
10
PR merge metrics
No merged PRs in 30d

Description

> Sharaf:
> do you use a special function for displaying messages?
> or simple println! will do?
>
> mitchell:
> some messages only need to be displayed occasionally
> that's why I prefer to look at these as "log" messages
> that way, you set the "log level" and you'll only get the messages you want
> for example users never want anything more than info and critical errors
> and developers want debug info available while debugging
> and some messages are good for seeing the program run (trace)
> I don't like to just use a print statement
> especially seeing developers go back and forth commenting messages between commits, it's so cumbersome

This is part of my plan for self-documenting code, or some better term. Because if you're going to comment something, then make it run and display at a useful time.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.