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

Leave an empty line between pod and code to all the files under lib #15139

Merged
merged 2 commits into from Jun 27, 2022

Conversation

b10n1k
Copy link
Contributor

@b10n1k b10n1k commented Jun 22, 2022

Following the recommendation all the perl POD documentation should have a
empty line before the beginning of the code as a good practice. In this PR all
the files which found under lib directory and its subdirectories are adding a
new line from all the cases which matched =cut\nsub

Signed-off-by: Ioannis Bonatakis ybonatakis@suse.com

@github-actions
Copy link

Great PR! Please pay attention to the following items before merging:

Files matching lib/**.pm:

  • Consider adding or extending unit tests in t/

This is an automatically generated QA checklist based on modified files

@mpagot
Copy link
Contributor

mpagot commented Jun 22, 2022

Why not to try to add the script that you used somewhere in the tools folder and call it from the Makefile?
If we agree about this comment style, why not to try to automatically "enforce" it (similar of what we are doing with perl tidy)?

@b10n1k
Copy link
Contributor Author

b10n1k commented Jun 23, 2022

Why not to try to add the script that you used somewhere in the tools folder and call it from the Makefile? If we agree about this comment style, why not to try to automatically "enforce" it (similar of what we are doing with perl tidy)?

CI is the next step. thats why is still draft as not complete

@b10n1k b10n1k marked this pull request as ready for review June 23, 2022 05:46
@b10n1k b10n1k requested review from mpagot and okurz June 23, 2022 05:46
Makefile Outdated Show resolved Hide resolved
tools/check_pod_whitespace_rule Show resolved Hide resolved
@b10n1k b10n1k force-pushed the pod_rule branch 2 times, most recently from f19f22d to 490fa36 Compare June 24, 2022 14:33
@b10n1k b10n1k force-pushed the pod_rule branch 3 times, most recently from 0b35bd5 to 1901408 Compare June 27, 2022 08:39
Following the recommendation all the perl POD documentation should have a
empty line before the beginning of the code as a good practice. In this PR all
the files which found under lib directory and its subdirectories are adding a
new line from all the cases which matched `=cut\nsub`

Signed-off-by: Ioannis Bonatakis <ybonatakis@suse.com>
As a convention the POD and the code needs to have an empty line in between.
The script checks all the files rather the commit files in the lib directory.
With this PR we enable validation of the rule in CI

Signed-off-by: Ioannis Bonatakis <ybonatakis@suse.com>
@b10n1k b10n1k merged commit c9ebb36 into os-autoinst:master Jun 27, 2022
@b10n1k b10n1k deleted the pod_rule branch August 24, 2023 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants