Skip to content

Improve proto field summary descriptions#3732

Open
rajeshd2091 wants to merge 1 commit into
istio:masterfrom
rajeshd2091:fix-httpmatch-description-summary
Open

Improve proto field summary descriptions#3732
rajeshd2091 wants to merge 1 commit into
istio:masterfrom
rajeshd2091:fix-httpmatch-description-summary

Conversation

@rajeshd2091

Copy link
Copy Markdown

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:

// HTTP method.
//
// Values are case-sensitive and formatted as follows:

instead of:

// HTTP Method
// values are case-sensitive and formatted as follows:

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

  • Ran make gen
  • Verified the generated CRD descriptions and API documentation render the expected summaries

@rajeshd2091 rajeshd2091 requested a review from a team as a code owner July 2, 2026 15:04
@istio-policy-bot

Copy link
Copy Markdown

😊 Welcome @rajeshd2091! This is either your first contribution to the Istio api repo, or it's been
a while since you've been here.

You can learn more about the Istio working groups, Code of Conduct, and contribution guidelines
by referring to Contributing to Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

@istio-testing istio-testing added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. needs-ok-to-test labels Jul 2, 2026
@istio-testing

Copy link
Copy Markdown
Collaborator

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-ok-to-test size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants