search

hmpf / easydmp

MIT License
7 stars 2 forks source link

Improve the sphinx docs #135

Closed hmpf closed 4 years ago

hmpf commented 4 years ago

These terms need to be indexed.

hmpf commented 4 years ago

Indexed by switching turning the list into a glossary.

hmpf commented 4 years ago

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.

adilhasan commented 4 years ago

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."?

hmpf commented 4 years ago

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.

codecov[bot] commented 4 years ago

Codecov Report

Merging #135 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 2c7e348...9be6969. Read the comment docs.