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

Add xmldoc comments to code #21

Merged
merged 1 commit into from
Jul 16, 2022
Merged

Add xmldoc comments to code #21

merged 1 commit into from
Jul 16, 2022

Conversation

benjiro
Copy link
Member

@benjiro benjiro commented Jul 16, 2022

Issue: #20

  • Document public code using xmldoc, and generate doc file
  • Avoid parallel test running to fix race condition when setting multiple provides on the Singleton instance which causes problems in the OpenFeature singleton tests

Signed-off-by: Benjamin Evenson <2031163+benjiro@users.noreply.github.com>
@benjiro benjiro requested a review from toddbaert July 16, 2022 13:39
@codecov-commenter
Copy link

Codecov Report

Merging #21 (b71ab26) into main (05de4b5) will increase coverage by 2.82%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main      #21      +/-   ##
==========================================
+ Coverage   96.50%   99.32%   +2.82%     
==========================================
  Files          15       15              
  Lines         286      297      +11     
  Branches       22       22              
==========================================
+ Hits          276      295      +19     
+ Misses          7        0       -7     
+ Partials        3        2       -1     
Impacted Files Coverage Δ
src/OpenFeature/Constant/Reason.cs 100.00% <ø> (ø)
src/OpenFeature/Extension/EnumExtensions.cs 100.00% <ø> (+20.00%) ⬆️
...enFeature/Extension/ResolutionDetailsExtensions.cs 100.00% <ø> (ø)
src/OpenFeature/Hook.cs 100.00% <ø> (ø)
src/OpenFeature/Model/ClientMetadata.cs 100.00% <ø> (ø)
src/OpenFeature/Model/FlagEvaluationOptions.cs 100.00% <ø> (ø)
src/OpenFeature/Model/HookContext.cs 100.00% <ø> (ø)
src/OpenFeature/Model/Metadata.cs 100.00% <ø> (ø)
src/OpenFeature/NoOpProvider.cs 100.00% <ø> (ø)
src/OpenFeature/Error/FeatureProviderException.cs 100.00% <100.00%> (ø)
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cb2e70b...b71ab26. Read the comment docs.

Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

LGTM after a quick check

@benjiro benjiro merged commit 4446810 into main Jul 16, 2022
@beeme1mr beeme1mr deleted the chore/add-docs branch July 19, 2022 12:32
@benjiro benjiro mentioned this pull request Aug 10, 2022
4 tasks
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.

None yet

3 participants