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

raw metrics of single line docstrings #143

Open
schettino72 opened this issue Jul 19, 2018 · 1 comment
Open

raw metrics of single line docstrings #143

schettino72 opened this issue Jul 19, 2018 · 1 comment

Comments

@schettino72
Copy link
Contributor

First, I have not read the code... just experimenting with some samples. Sorry if I got any wrong conclusion.

I have noticed that single-line docstrings are counted as single_comments but not comments.

The problem is that on "Comment Stats", the C seems to refers to comments so single line docstrings are never include even on C + M. I guess a quick solution would be make:

C = single_comments + non_single_comments

comments should not be used because lines with# is counted both on comments and single_comments.


Going a bit off-topic. IMO a better solution would be to remove the multi count, instead have docstring count that would count lines for both single-line or multi-line docstring. And comments would count just lines with #.

what do you think?

@rubik
Copy link
Owner

rubik commented Jul 27, 2018

I agree, your proposed solution makes a lot of sense. The current implementation is the result of multiple changes that weren't so well thought-out unfortunately. At the moment I'm very busy and I cannot really work on this. However, I will gladly review any PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants