docs(CertificateManager/ICertificateManager): clarify API#60363
Open
joshtrichards wants to merge 3 commits into
Open
docs(CertificateManager/ICertificateManager): clarify API#60363joshtrichards wants to merge 3 commits into
joshtrichards wants to merge 3 commits into
Conversation
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
joshtrichards
changed the title
joshtrichards
changed the title
joshtrichards
added
3. to review
joshtrichards
requested review from
CarlSchwan,
artonge,
blizzz,
icewind1991,
leftybournes,
provokateurin and
salmart-dev
and removed request for
a team
Member
There was a problem hiding this comment.
Please just remove all doc comments from the public methods inherited by the interface. They also automatically inherit the doc comments and having them duplicated can cause issues if they get out of sync.
Member
Author
There was a problem hiding this comment.
Agreed. Done. Thanks for the nudge. :)
Signed-off-by: Josh <josh.t.richards@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This updates both
CertificateManagerandICertificateManagerto keep the concrete implementation and public contract aligned - and to fully document the OCP API.Notes
Only functional change is making the
CertificateManager::createCertificateBundle()helper private. It was already not part of the interface and is only used internally within the implementation itself.TODO
Checklist
3. to review, feature component)stable32)AI (if applicable)