Skip to content
This repository has been archived by the owner on Nov 15, 2022. It is now read-only.

Add comments on code for better understand #10

Open
PeterF521 opened this issue Jul 31, 2020 · 3 comments
Open

Add comments on code for better understand #10

PeterF521 opened this issue Jul 31, 2020 · 3 comments

Comments

@PeterF521
Copy link

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?

@djcouto
Copy link
Member

djcouto commented Aug 4, 2020

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 djcouto closed this as completed Aug 4, 2020
@marado
Copy link
Contributor

marado commented Aug 4, 2020

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.

@djcouto
Copy link
Member

djcouto commented Aug 4, 2020

Hi @marado, I'll follow your suggestion.

@djcouto djcouto reopened this Aug 4, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants