Skip to content

CS1591 warnings#2139

Merged
jzabroski merged 26 commits into
mainfrom
inheritdoc
Sep 2, 2025
Merged

CS1591 warnings#2139
jzabroski merged 26 commits into
mainfrom
inheritdoc

Conversation

@jzabroski

Copy link
Copy Markdown
Collaborator

No description provided.

@jzabroski jzabroski added this to the 7.2.0 milestone Aug 30, 2025
@jzabroski

Copy link
Copy Markdown
Collaborator Author

@github update this PR with an additional commit that adds where appropriate:

///

You can use the build result from the prior commit fir CS1591 warnings as a hint.

…pt: Fix all CS1591 errors in this file. Use <inheritdoc /> where appropriate.
@jzabroski

jzabroski commented Aug 31, 2025

Copy link
Copy Markdown
Collaborator Author

@PhenX I am out of Copilot free tier tokens. But I think I made a pretty huge dent in the CS1591 warnings with it. My tokens reset on 9/5. So, may be possible to get a lot more progress by end of next week.

@jzabroski

Copy link
Copy Markdown
Collaborator Author

2181 Warning(s) left. So knocked off about 33% of the warnings.

@jzabroski

Copy link
Copy Markdown
Collaborator Author

@jzabroski

jzabroski commented Aug 31, 2025

Copy link
Copy Markdown
Collaborator Author

Next good candidates for one-shot prompt:

  1. ConnectionlessVersionLoader 45
image 2. GeneratorBase 33 image 3. GenericGenerator 49 image 4. GenericQuoter image 5. RunnerContext 23 image 6. ProcessorBase 54 image 7. Db2Processor - missed this one when doing all the processors 8. FirebirdTruncator 35 9. FirebirdSchemaInfo 62 image 10. JetProcesor 25
  1. PostgresGenerator - 78

  2. VersionLoader - 22

@jzabroski

Copy link
Copy Markdown
Collaborator Author

2138 warnings

@jzabroski

Copy link
Copy Markdown
Collaborator Author

1664 warnings

@jzabroski

Copy link
Copy Markdown
Collaborator Author

1579 warnings

@jzabroski

Copy link
Copy Markdown
Collaborator Author

1383 warnings

/// </summary>
/// <remarks>
/// This class provides mappings between .NET <see cref="DbType"/> values and their corresponding Firebird SQL types.
/// It extends the <see cref="TypeMapBase"/> class and implements the <see cref="IFirebirdTypeMap"/> interface.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This kind of comments make me think of this 😅

Image

Do we need to repeat the implements and inherits ?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

It's all automated. I don't like it but the marginal cost of my time to remove it is higher than to keep it right now. Feel free to add to this PR to remove it. Even with Copilot and DocumentationAssistant, it takes time to go through all these warnings. It's 8+ years of tech debt.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Yeah, that's great that you do this ! About warnings, did you see my suggestion about IQuoter warnings ? I tried it and it works well

@jzabroski

Copy link
Copy Markdown
Collaborator Author

917 warnings left

@jzabroski

Copy link
Copy Markdown
Collaborator Author

460 warnings

@jzabroski

Copy link
Copy Markdown
Collaborator Author

354 warnings

@jzabroski

Copy link
Copy Markdown
Collaborator Author

0 CS1591 warnings

@jzabroski
jzabroski marked this pull request as ready for review September 2, 2025 13:42
@jzabroski
jzabroski merged commit 2a1b20b into main Sep 2, 2025
2 checks passed
@jzabroski
jzabroski deleted the inheritdoc branch September 2, 2025 13:43
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.

2 participants