Improve Readme - Githubissues

fzipp / gocyclo

Calculate cyclomatic complexities of functions in Go source code.

BSD 3-Clause "New" or "Revised" License

1.33k stars 81 forks source link

Improve Readme #10

Closed variadico closed 3 years ago

variadico commented 8 years ago

Hello.

I've been seeing gocyclo appear in more places. Congrats. But, I don't understand what it actually does. I think the readme could include more information for noobs.

Gocyclo calculates cyclomatic complexities of functions in Go source code.

That statement leaves me with some questions:

What are "cyclomatic complexities of functions"?
What is considered good/bad?
Why is it considered good/bad?
If code is flagged, what can I do to fix it?

saniales commented 6 years ago

This can also appear in wiki section (which is a nice to have too)