Add comment on all uses of embedded types #4059
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MrAlias
added
documentation
MrAlias
requested review from
Aneurysm9,
evantorrie,
XSAM,
dashpole,
MadVikingGod,
pellared,
hanyuancheung and
dmathieu
as code owners
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #4059 +/- ##
=====================================
Coverage 82.2% 82.2%
=====================================
Files 175 175
Lines 13058 13058
=====================================
+ Hits 10734 10738 +4
+ Misses 2103 2099 -4
Partials 221 221
|
hanyuancheung
approved these changes
May 6, 2023
pellared
approved these changes
May 8, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based on user feedback, it was mentioned that the embedded types are confusing to new users of the API. It is not clear if they need to understand their purpose or what function they provide them in performing operations. This updates all types that use an embedded type with documentation about the purpose of the embedding and where to find more information.