-
Notifications
You must be signed in to change notification settings - Fork 2
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
Improve the sphinx docs #135
Conversation
These terms need to be indexed. |
Indexed by switching turning the list into a glossary. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello Hanne,
it's a bit complicated. Aren't all questions associated to a section? So, I can't understand the distinction between optional question and optional section question. I wonder if we could simplify a little bit? I mean we could have optional X where X could be a question or section? I think getting all the terms down is valuable. Maybe we can rationalise it a bit
Are you talking about the terminology list? "optional question" and "optional section question" are not the same thing. "optional section question" makes an entire section optional. |
So, maybe we need to improve the terminology list as I think it's quite subtle. Does the optional section question address the case where I would want to want to make an entire section optional. Ie "For this submission, users must fill in sections 1, 3, 4. Sections 2 and 5 are optional for this submission."? |
Yes, exactly. It's magical BooleanQuestion and an implementation detail, but we need to document it somewhere and agree on terminology for it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello Hanne, sorry for the delay in getting back to you on this. It seems to me to be fine.
hth adil
Remove the old flow and show the new.
Codecov Report
@@ Coverage Diff @@
## master #135 +/- ##
=======================================
Coverage 61.01% 61.01%
=======================================
Files 110 110
Lines 6718 6718
=======================================
Hits 4099 4099
Misses 2619 2619 Continue to review full report at Codecov.
|
No description provided.