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

Go "Enums" are not generated with godoc into cluster_spec.md #1908

Open
nicmorales9 opened this issue Dec 20, 2023 · 0 comments
Open

Go "Enums" are not generated with godoc into cluster_spec.md #1908

nicmorales9 opened this issue Dec 20, 2023 · 0 comments
Labels
bug Something isn't working

Comments

@nicmorales9
Copy link
Contributor

What happened?

In cluster_spec.md lots of helpful information is generated from struct information, however, the docgen is not setup to generate helpful information for Go "enums" such as processGroupConditionType, which does not have the values geneated for it, e.g. https://github.com/FoundationDB/fdb-kubernetes-operator/blob/main/docs/cluster_spec.md#processgroupconditiontype
It would be fantastic if the docgen code in cmd/po-docgen/api.go was extended to allow this information to get documented too, as currently users have to grep the codebase for the variables.

What did you expect to happen?

I expect all the values in cluster_spec.md to have helpful information about the possible options in a tabular form like for the structs that are autogenerated.

How can we reproduce it (as minimally and precisely as possible)?

N/A

Anything else we need to know?

No response

FDB Kubernetes operator

N/A

Kubernetes version

N/A

Cloud provider

N/A

@nicmorales9 nicmorales9 added the bug Something isn't working label Dec 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant