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

KCL docs: param list is hard to read #3846

Open
adamchalmers opened this issue Sep 9, 2024 · 2 comments
Open

KCL docs: param list is hard to read #3846

adamchalmers opened this issue Sep 9, 2024 · 2 comments

Comments

@adamchalmers
Copy link
Collaborator

adamchalmers commented Sep 9, 2024

The current KCL docs list each function's parameters. The parameter list looks like:

kcl docs arg list

In my opinion, this is hard to read. I think it's hard to immediately tell where the parameter name ends and the parameter type begins. Each one takes up an inconsistent visual height too.

I suggest we actually display a table, with one row for each parameter. Columns would be Name, Type and Required.

Name Type Required
num_repetitions u32 Required
transform_function Function Required
extrude_group_set ExtrudeGroupSet Required
@franknoirot
Copy link
Collaborator

I love this idea. The tables for the API docs can serve as a reference if you like https://zoo.dev/docs/api/file/get-cad-file-mass?lang=typescript#parameters-material_density

@jessfraz
Copy link
Contributor

jessfraz commented Sep 9, 2024

i think @franknoirot they'd be markdown tables here and in the docs, then will convert when passed to website

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants