docs(inventory): remove leaked TBD comments - #488
Open
RedZapdos123 wants to merge 1 commit into
Open
Conversation
Signed-off-by: Mridankan Mandal <xerontitan90@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
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.
Description:
Issue #487 reported that placeholder public comments in
inventory/inventory.protowere still set toTBD, and those placeholders were leaking into checked-in generated documentation and Swagger output.MemoryInfo.total_usable_byteshad no real field description, andPCIeDeviceInfostill carried unresolvedType 9 or Type 41 ?text. Because these are public proto comments, the placeholders propagated intoinventory/v1/autogen.md,inventory/v1/gen/go/inventory.swagger.json, and generated Go comments.This PR replaces those placeholders with accurate wording:
total_usable_bytesnow explains that it is the usable memory capacity available to the system, not current memory usage.PCIeDeviceInfonow describes a single PCIe device discovered on the system instead of keeping unresolved placeholder text.It also updates the checked-in generated documentation and generated Go comments so the public artifacts no longer expose
TBD.Closes #487.
Checklist:
inventory/inventory.proto.buf lint.protoc.TBDplaceholders.Before the fix:
inventory/inventory.protostill contained placeholder comments:Those placeholders also appeared in checked-in generated artifacts, for example:
After the fix:
The source comments now describe the field and message directly:
The checked in generated docs and generated Go comments were updated to match, and the affected inventory artifacts no longer expose
TBD.