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

Feature/fix typos in readme #7

Merged
merged 7 commits into from
Jun 20, 2024
Merged

Conversation

miroslavpojer
Copy link
Collaborator

@miroslavpojer miroslavpojer commented Jun 20, 2024

  • Fixed typo issue in README: _ instead of -.
  • Update the code to where it worked with _ too.
  • Updated unit tests.

Also closes #6

- Rename of action output methods.
- Rework of get input logic to usage of constants.
@miroslavpojer
Copy link
Collaborator Author

Release notes:

  • Fixed usage of '_' and '-' in code and documentation.
  • Refactoring of action input logic.

set_action_output('violation-count', str(violation_count))

if verbose_logging:
print(f'Total violations: {violation_count}')

Choose a reason for hiding this comment

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

What's the difference of print and logging?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Print output is independent of logging settings.
What level would you propose?

Choose a reason for hiding this comment

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

That's extra weird. There are good chances, that verbose set to true will print out the same info twice.
My suggestion:

  • treat console as console only output, but print there even if other option is used (and adjust descripton accordingly)
  • if verbose is false, print only the violations number, if true print all violations

Or use other logic. But this is IMHO wrong.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Improved.

@miroslavpojer miroslavpojer merged commit 61c9cc9 into master Jun 20, 2024
2 checks passed
@miroslavpojer miroslavpojer deleted the feature/fix-typos-in-readme branch June 20, 2024 14:54
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.

Can you clarify report_format setting please?
3 participants