Skip to content

fix: prevent object properties from showing as separate parameters (#810) #818

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

Open
wants to merge 1 commit into
base: 2.0
Choose a base branch
from

Conversation

kajal-jotwani
Copy link

Fixes: #810

This PR fixes the issue where object properties were incorrectly showing up as separate parameters in the reference documentation.

image

@davepagurek
Copy link
Collaborator

Thanks @kajal-jotwani! Do you think there would be a way to still see a way to display the properties and their descriptions below the object itself in this example, but just not show it in the Syntax section as separate items? e.g. keeping this, which looks great:
image

...but below, showing the properties still? maybe something like this? (just a mockup, open to other designs!)
image

@kajal-jotwani
Copy link
Author

I think we can do that I'll try to do it and share the updates

@kajal-jotwani
Copy link
Author

image

Hello @davepagurek!
I wanted to get your review on this whenever you get the chance.

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

Successfully merging this pull request may close these issues.

2 participants