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

Xml comment grammar fixes & documentation improvements #844

Merged
merged 1 commit into from
Feb 19, 2023

Conversation

phillipsawyer
Copy link
Contributor

Proposed change

Xml comment clean up 🧹. As a side-note, annoyingly, Rider does not work with inheritdoc in some cases. An example is StateChanges(). VS works.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (which adds functionality to an existing integration)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the [development checklist][dev-checklist]
  • The code compiles without warnings (code quality chek)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

@phillipsawyer phillipsawyer changed the title grammar & doc fixed Xml comment grammar fixes & documentation improvements Feb 17, 2023
@codecov
Copy link

codecov bot commented Feb 17, 2023

Codecov Report

Base: 80.98% // Head: 81.03% // Increases project coverage by +0.04% 🎉

Coverage data is based on head (1dc992b) compared to base (c263a7f).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #844      +/-   ##
==========================================
+ Coverage   80.98%   81.03%   +0.04%     
==========================================
  Files         159      159              
  Lines        4107     4107              
  Branches      406      406              
==========================================
+ Hits         3326     3328       +2     
+ Misses        620      619       -1     
+ Partials      161      160       -1     
Flag Coverage Δ
unittests 81.03% <ø> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...t/Extensions/IHomeAssistantConnectionExtensions.cs 90.47% <ø> (ø)
...n.HassClient/Common/HomeAssistant/Model/Targets.cs 100.00% <ø> (ø)
...t/NetDaemon.HassClient/Common/Settings/Settings.cs 100.00% <ø> (ø)
...odel.Integration/IntegrationHaContextExtensions.cs 86.95% <ø> (ø)
...c/HassModel/NetDeamon.HassModel/Entities/Entity.cs 78.12% <ø> (ø)
...l/NetDeamon.HassModel/Entities/EntityExtensions.cs 44.44% <ø> (ø)
...n.HassModel/Entities/EnumerableEntityExtensions.cs 95.23% <ø> (ø)
src/HassModel/NetDeamon.HassModel/Event.cs 88.88% <ø> (ø)
...n.HassModel/Internal/AppScopedHaContextProvider.cs 85.10% <ø> (ø)
src/HassModel/NetDeamon.HassModel/ServiceTarget.cs 87.50% <ø> (ø)
... and 1 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@FrankBakkerNl FrankBakkerNl merged commit f58c0c7 into net-daemon:dev Feb 19, 2023
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.

None yet

2 participants