KusionStack/konfig

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

Closed this issue · 0 comments

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:

image: str, default is Undefined, optional.

source code:

image: str = option("image")

ref: kcl-lang/kcl#281

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

for example:

the attribute image should not be not limited to docker image