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

#6 Count pure markup files as documentation #170

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

snowkoli
Copy link
Collaborator

Close #6

@coveralls
Copy link

coveralls commented Jul 14, 2024

Coverage Status

coverage: 95.972% (+0.02%) from 95.951%
when pulling 8ed8bcd on 6-count-pure-markup-files-as-documentation
into 6697e79 on main.

@snowkoli snowkoli requested a review from roskakori July 14, 2024 19:19
]
actual_line_parts = AnalysisTest._line_parts("markdown", source_lines)
expected_line_parts = [{"d"}, {"d"}, {"d"}, {"d"}, {"d"}, {"d"}, set()]
assert actual_line_parts == expected_line_parts
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The can probably be expressed more concise with:

assert all(line_part = "d" for line_part in actual_line_parts), f"line_part={line_part}"

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've followed your suggestion and made a small adjustment. Additionally, I've updated the README.md file. Could you please take a look when you have a moment?

image

Copy link
Collaborator Author

@snowkoli snowkoli Jul 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it acceptable that not all lines are categorized as documentation?
Markdown details:
{"documentationCount": 53, "documentationPercentage": 49.074074074074076, "codeCount": 0, "codePercentage": 0.0, "emptyCount": 21, "emptyPercentage": 19.444444444444443, "fileCount": 3, "filePercentage": 7.894736842105263, "isPseudoLanguage": false, "language": "Markdown", "sourceCount": 34, "sourcePercentage": 31.48148148148148, "stringCount": 34, "stringPercentage": 31.48148148148148 }

@snowkoli snowkoli requested a review from roskakori July 18, 2024 22:33
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

Successfully merging this pull request may close these issues.

Count pure markup files as documentation
3 participants