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

How to document JS API objects with nested definitions #1357

Open
heitortsergent opened this issue Oct 3, 2023 · 0 comments
Open

How to document JS API objects with nested definitions #1357

heitortsergent opened this issue Oct 3, 2023 · 0 comments
Labels
Tech Writers Issues that a writer could help with WIP

Comments

@heitortsergent
Copy link
Collaborator

Related to #1348.

When documenting k6's JS API, we don't currently have a great/standard way of providing a definition for the properties of objects with nested objects with them.

One way to do it is to provide multiple tables, one for each object, in the same page, although they can be a little hard to parse.

How can we improve this? How do other libraries/docs handle this?

@heitortsergent heitortsergent added Tech Writers Issues that a writer could help with WIP labels Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Tech Writers Issues that a writer could help with WIP
Projects
None yet
Development

No branches or pull requests

1 participant