Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc.: Many contradictory "Description: REQUIRED. ..." / "Required: No" rows #2032

Open
dsbos opened this issue Jun 23, 2021 · 2 comments
Open

Comments

@dsbos
Copy link

dsbos commented Jun 23, 2021

On the current Global Mesh Options page, there are many rows whose Description column value says "REQUIRED. ..." but whose Required column value says "No"--which certainly seems to be contradictory.

So ... are those rows' documented members (fields) required or not?

(If those two forms refer to two different levels of being required, that page should make that fact clear.)

@ericvn
Copy link

ericvn commented Jun 23, 2021

Since this page is generated in the istio/api repo, I'll move the PR there.

@howardjohn
Copy link
Member

fwiw the column comes from proto annotations vs docs comments. Agree this needs cleanup

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants