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

New API docs - list of arguments #7

Open
Maksims opened this issue Jan 24, 2024 · 0 comments
Open

New API docs - list of arguments #7

Maksims opened this issue Jan 24, 2024 · 0 comments

Comments

@Maksims
Copy link

Maksims commented Jan 24, 2024

Current docs show list of arguments as a table:

image

It is implemented using 3 columns, which is not ideal as it leaves very little space horizontally, while suffering with a large empty space due to description is most of the time multiple lines height.

The new API docs, uses lists, with indent, and a lot of similar coloring in various places that makes it extremely hard to identify actual arguments that can be provided into constructor:
image

Especially for nested properties when passing more complex objects:
image

Table with a two rows would make it much better:
image

@willeastcott willeastcott transferred this issue from playcanvas/developer.playcanvas.com Jan 24, 2024
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

1 participant