issue-1186 Remove released status handling from AssignmentBuilder#1191
issue-1186 Remove released status handling from AssignmentBuilder#1191bnmnetp merged 1 commit intoRunestoneInteractive:mainfrom
Conversation
… AssignmentList components issue-1187 Add JSON schema documentation for question_json field
bnmnetp
left a comment
bnmnetp
left a comment
There was a problem hiding this comment.
This looks good. I like the structure. The markdown doesn't work with our RST in the docs structure. But I had Copilot convert it to RST as a test and it looks fine to me. If you have your own script or tool for generating some of this and it can create RST that might be better for whenever this changes. If not let me know and I can use the RST as I converted it.
|
|
||
| ## Field Reference | ||
|
|
||
| All fields within `question_json` are **optional** at the top level (`Partial<{...}>`). Only the fields relevant to a particular `question_type` are populated when the JSON is built. |
There was a problem hiding this comment.
I don't know what Partial<{...}> is supposed to mean. Maybe if I knew more TS it would be obvious?
There was a problem hiding this comment.
Ah, yes, sorry, this is a common TS utility type, there is a documentation https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype
Regarding MD -> RST, I'd propose the following: If you’ve now managed to convert MD to RST, could you please apply your changes?
Going forward, I’ll write everything directly in RST format. Also, could you please let me know if you’d like me to write documentation for all new features right away?
2 participants
… AssignmentList components
#1187 Add JSON schema documentation for question_json field
#1186 Remove released status handling from AssignmentBuilder