Improve proto field summary descriptions#3732
Conversation
|
😊 Welcome @rajeshd2091! This is either your first contribution to the Istio api repo, or it's been You can learn more about the Istio working groups, Code of Conduct, and contribution guidelines Thanks for contributing! Courtesy of your friendly welcome wagon. |
|
Hi @rajeshd2091. Thanks for your PR. I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
What does this PR change?
This PR updates proto field comments so that the first line is a complete summary sentence, followed by a blank line before the detailed description.
For example:
instead of:
Why?
The first sentence(Till first full stop) of a proto comment is used as the summary in generated documentation, including CRD descriptions (
kubectl explain) and the Istio API reference.Making the summary a standalone sentence results in concise, readable descriptions while preserving the existing detailed documentation.
This is in-line with other param description and format
Testing
make gen