Skip to content

Conversation

@networkfusion
Copy link
Member

@networkfusion networkfusion commented Dec 17, 2022

Description

Motivation and Context

  • The project file was missing <Content Include="packages.lock.json" />
  • Add missing xml documentation.

How Has This Been Tested?

Screenshots

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue with code or algorithm)
  • New feature (non-breaking change which adds functionality to code)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dependencies (update dependencies and changes associated, has no impact on code or features)
  • Unit Tests (add new Unit Test(s) or improved existing one(s), has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist:

  • My code follows the code style of this project (only if there are changes in source code).
  • My changes require an update to the documentation (there are changes that require the docs website to be updated).
  • I have updated the documentation accordingly (the changes require an update on the docs in this repo).
  • I have read the CONTRIBUTING document.
  • I have tested everything locally and all new and existing tests passed (only if there are changes in source code).
  • I have added new tests to cover my changes.

Add missing xml documentation.
@networkfusion
Copy link
Member Author

Copy link
Member

@Ellerbach Ellerbach left a comment

Choose a reason for hiding this comment

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

Looks good to me. We definitely should add the linter on more repositories!

Copy link
Member

@josesimoes josesimoes left a comment

Choose a reason for hiding this comment

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

Always better to have the Intellisense comets there.
To me, the thing with the ones here, is that they do not explain anything to the developer using them. They're are just repeating the name of the method... the warning will go away, sure, but nothing will become clearer by providing these...

@networkfusion
Copy link
Member Author

I guess this is a comprimise.
It is better to not have warnings, and as it stands, the project was inconsistant with the approach.
Surely this is also useful for the generated documentation?

Either way, let me know whether this can be merged so we can move on.

@josesimoes josesimoes enabled auto-merge (squash) December 22, 2022 14:34
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@Ellerbach
Copy link
Member

@networkfusion this PR has conflict now. Either resolves them, either close the PR and reopen it. I was even thinking to add the linter on it. That would force to clean the comments as well.

auto-merge was automatically disabled April 22, 2023 15:16

Pull request was closed

@networkfusion networkfusion reopened this Apr 22, 2023
@networkfusion networkfusion requested a review from Ellerbach April 22, 2023 15:23
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Copy link
Member

@Ellerbach Ellerbach left a comment

Choose a reason for hiding this comment

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

Thanks, that looks all good as well.

@josesimoes josesimoes changed the title Add missing documentation Fix comments for Intellisense Apr 24, 2023
@josesimoes josesimoes merged commit a0e263d into main Apr 24, 2023
@josesimoes josesimoes deleted the project-fixes branch April 24, 2023 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants