search

KusionStack / konfig

Shared repository of application models and components, and CI suite for GitOps workflows
Apache License 2.0
27 stars 32 forks source link

docs in konfig codes need to be grammarly checked and polished in technical perspective #57

Closed amyXia1994 closed 1 year ago

amyXia1994 commented 1 year ago

there are inconsistencies between docstrings and source code in the docstring-Attributes Part.

for example: (and there are many other similar problems among the repo) docstring: https://github.com/KusionStack/konfig/blob/d461bee18fe5e27b97b5776d0e8b7615d0d65599/base/pkg/kusion_models/kube/frontend/server.k#L21

source code: https://github.com/KusionStack/konfig/blob/d461bee18fe5e27b97b5776d0e8b7615d0d65599/base/pkg/kusion_models/kube/frontend/server.k#L98

ref: https://github.com/KusionStack/KCLVM/issues/281

there are some improper statement about the attribute description in docstring-Attributes Part.

for example: https://github.com/KusionStack/konfig/blob/d461bee18fe5e27b97b5776d0e8b7615d0d65599/base/pkg/kusion_models/kube/frontend/server.k#L22

the attribute image should not be not limited to docker image