Cluster-api: Godoc for the api types need curation

Created on 25 Sep 2019  路  6Comments  路  Source: kubernetes-sigs/cluster-api

When parsing the API via godoc which is the standard consumption model for most Go developers, it's in a very bad state to the point of being illegible. This should be the canonical source of truth that developers should be able to reference when trying to understand the API and it's behaviors.

https://godoc.org/github.com/kubernetes-sigs/cluster-api/api/v1alpha2

areux kindocumentation prioritimportant-longterm

Most helpful comment

/assign

All 6 comments

/assign

/assign

@randomvariable FYI the first thing I'm taking a look at is how to fix up those conversion functions that were generated and exported. So ugly :(

/milestone v0.3.0

Trying to keep only the bare minimum in v0.2.x so we can eventually close it out

going to close this as it's more an ongoing issue and it should probably be tackled with linters and during reviews, feel free to reopen if necessary

/close

@vincepri: Closing this issue.

In response to this:

going to close this as it's more an ongoing issue and it should probably be tackled with linters and during reviews, feel free to reopen if necessary

/close

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/test-infra repository.

Was this page helpful?
0 / 5 - 0 ratings