stayaway-app icon indicating copy to clipboard operation
stayaway-app copied to clipboard

Add comments on code for better understand

Open PeterF521 opened this issue 3 years ago • 3 comments

For better code understand, we should add comments like this:

// A brief explanation about 'Teste' function
function teste(param) {
    // Other explanation
}

What do you think?

PeterF521 avatar Jul 31 '20 14:07 PeterF521

Hi @PeterF521 and thank you for opening this issue.

We already left comments on some of the most important components of the project. We agree that there is room for improvement but this is not a top priority.

djcouto avatar Aug 04 '20 14:08 djcouto

Hi @djcouto: if there is room for improvement, even if this isn't top priority, why are you closing this issue? Leaving it open not only reflects your statement that there is room for improvement, but also lets others be easily aware of that room for improvement, and possibly even come up with contributions towards this goal.

May I suggest that, instead of closing issues, to use labels for them? A "Low Priority" label, for example, would probably be more useful for everyone.

marado avatar Aug 04 '20 14:08 marado

Hi @marado, I'll follow your suggestion.

djcouto avatar Aug 04 '20 14:08 djcouto