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

Fix warnings #1104

Merged
merged 2 commits into from
Jun 2, 2024
Merged

Fix warnings #1104

merged 2 commits into from
Jun 2, 2024

Conversation

drolevar
Copy link
Contributor

The parameter file_header_template in .editorconfig introduces the check for the file header. However, if the header comment contains more lines than specified in file_header_template, the header is detected as incorrect.
This triggers a very significant number of Roslyn analyzer warnings, which makes it hard to detect the real issues.

The solution is to split the header comment into two: the one specified in file_header_template and the rest.

Sometimes as a result the second part triggers the SA1512 warning, so it has to be converted to a multi-line comment.

Pull request type

Please check the type of change your PR introduces:

  • Update
  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes

drolevar added 2 commits May 31, 2024 10:28
IDE0073 is caused by setting file_header_template and having more lines in the header comment than specified in the template.
SA1512 is caused by having an empty line between a single-line comment and following code.
@drolevar drolevar requested a review from pomianowski as a code owner May 31, 2024 08:39
@github-actions github-actions bot added controls Changes to the appearance or logic of custom controls. PR Pull request navigation Changes to navigation related controls. gallery WPF UI Gallery dotnet tray labels May 31, 2024
@pomianowski pomianowski merged commit 334ded5 into lepoco:development Jun 2, 2024
2 checks passed
@pomianowski
Copy link
Member

Hey @drolevar, thank you for your contribution

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
controls Changes to the appearance or logic of custom controls. dotnet gallery WPF UI Gallery navigation Changes to navigation related controls. PR Pull request tray
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants