-
Notifications
You must be signed in to change notification settings - Fork 23
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
Table doesn't state which attributes are required or not #78
Comments
Required fields are indicated by bold type. |
I see that now, at least with the read the docs style above, the contrast difference is not very obvious. What are your thoughts on changing this to be explicit with a new line item for each property stating if it is required or not? I am using schema's to define configuration files so the less I have to document outside the table for the user the better. |
Let's start by saying that I haven't found this to be a problem. Alternatives: anything you can think of. So you could replace the bold print with class then use CSS to turn it in whatever you want. Or include a superscripted What worries me a bit is that the number of options and switches is expanding really fast. Would that work for you? |
I see what you mean and I agree. For my projects, there's a limited subset of JSON schema that I use, and have a preference for how I think it should look. With that said, I do understand that others have different preferences.
It would work for me, however, I don't think this is critical to change considering the bold-face formatting already identifies required properties. The feedback in my previous comment was to point out that it wasn't obvious to me. I can live with the current implementation, but you're welcome to leave this open if you see value in providing this capability or want feedback from others. |
After the 1.19.0 release, I attempted to document my python object. Anyways, my schema looks sort of like this:
I'm intentionally leaving out the defs as I don't think they're relevant and they're also not something I can share. As you'll see above,
core_spec
andcores
should both be required butdescription
should be optional. In the produced documentation, I'm not seeing any indication of this:I think there should be an extra field stating if the object is required or not.
Anyways, I'm super stoked that the feature in 1.19.0 works, this looks much better than I was hoping and is certainly much more elegant than the table I was maintaining manually 👍
The text was updated successfully, but these errors were encountered: