Possible bug in generating docs

[mihaigalos]

Hi,

Not sure if I'm doing something wrong but I'm trying to generate docs for https://github.com/kcl-lang/modules/blob/main/crossplane-provider-aws/v1alpha1/acm_aws_crossplane_io_v1alpha1_certificate.k and it doesn't work correctly:

wget https://github.com/kcl-lang/modules/blob/main/crossplane-provider-aws/v1alpha1/acm_aws_crossplane_io_v1alpha1_certificate.k

kcl mod init && kcl doc generate

I get this:

name	type	description	default value
deletionPolicy	"Orphan"	"Delete"	DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either "Delete" or "Orphan" the external resource.

So the deletionPolicy is of type "str" according to the inline docs but shown as "Orphan".

Running with this:

kcl --version
0.11.2

If this discussion identifies a bug, please direct me to the repo I can open up an issue. Thanks!

[mihaigalos]

Modified it to this form, type and description now works but default value isn't shown:

-deletionPolicy?: "Orphan" | "Delete" = "Delete"
+deletionPolicy?: str "Orphan" | "Delete" = "Delete"

name	type	description	default value
deletionPolicy	str	DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either "Delete" or "Orphan" the external resource.

Also, seens the inline docs just repeat the type and the default values? - this is prone to error and needs maintaining in both places but the truth is in the schema definition, not the comments for docs:

    deletionPolicy : str, default is "Delete", optional

[mihaigalos]

Closed in kcl-lang/kcl-go#476.