10000 Improve the maxbodylength rule description by obnoxxx · Pull Request #111 · checkmake/checkmake · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Improve the maxbodylength rule description #111

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 9, 2025
Merged

Improve the maxbodylength rule description #111

merged 2 commits into from
May 9, 2025

Conversation

obnoxxx
Copy link
Collaborator
@obnoxxx obnoxxx commented May 8, 2025 •
edited
Loading

Description of changes:

The description of the maxbodylength rule shown with `checkmake --list-rules` 
was not very specific:

      maxbodylength       Target bodies should be kept
                          simple and short.

This change adds the detail that length refers to a certain maximum
number of lines:

 
      maxbodylength       Target bodies should be kept
                          simple and short (no more than
                          5 lines).

This is a follow-up to PR #109 depending on it) and a partial solution to issue #108

Checklist

Not all of these might apply to your change but the more you are able to check
the easier it will be to get your contribution merged.

  • CI passes
  • Description of proposed change
  • Documentation (README, docs/, man pages) is updated
  • Existing issue is referenced if there is one
  • Unit tests for the proposed change

@obnoxxx
rules: clarify the violation message for maxbodylength
0db4c22 
This mentions that maxbodylength is in number of lines.

Fixes: checkmake#90

Signed-off-by: Michael Adam <obnox@samba.org>
@obnoxxx obnoxxx mentioned this pull request May 8, 2025
Merged
5 tasks
@obnoxxx obnoxxx force-pushed the improve-maxbodylength-description branch from ada1ac1 to 278efef Compare May 8, 2025 17:36
@obnoxxx
rules: expand the description of the maxbodylength rule
5baeea9 
The description of the maxbodylength rule shown with --list-rules
weas not very specific:

  maxbodylength       Target bodies should be kept
                      simple and short.

This change adds the detail that length refers to a certain maximum
number of lines:

  maxbodylength       Target bodies should be kept
                      simple and short(no more than
                      5 lines).

Signed-off-by: Michael Adam <obnox@samba.org>
@obnoxxx obnoxxx force-pushed the improve-maxbodylength-description branch from 278efef to 5baeea9 Compare May 8, 2025 17:38
@obnoxxx
Copy link
Collaborator Author
obnoxxx commented May 8, 2025

@mrtazz seems like the CI needs approval to run.

If you like this, I suggest you merge #109 first (which is contained in this one) so that I can rebase this.

@mrtazz mrtazz merged commit e11578c into checkmake:main May 9, 2025
1 check passed
@obnoxxx obnoxxx deleted the improve-maxbodylength-description branch May 9, 2025 17:04
@obnoxxx obnoxxx mentioned this pull request May 12, 2025
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@obnoxxx @mrtazz
0