[WIP] [DOC] describe content of cfg and of checkCFG

[Remi-Gau]

TODO

• describe content and use of cfg in rst doc
• describe what checkCFG does in the help section

[codecov]

Codecov Report

Merging #125 (460ec45) into doc (cc99e1e) will decrease coverage by 0.03%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##              doc     #125      +/-   ##
==========================================
- Coverage   81.00%   80.97%   -0.04%     
==========================================
  Files          29       29              
  Lines         616      615       -1     
==========================================
- Hits          499      498       -1     
  Misses        117      117              

Flag	Coverage Δ
unittests	80.97% <100.00%> (-0.04%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/utils/transferInfoToBids.m	100.00% <ø> (ø)
src/checkCFG.m	98.82% <100.00%> (-0.02%)	⬇️
src/userInputs.m	0.00% <0.00%> (ø)
src/gui/askUserCli.m	0.00% <0.00%> (ø)
src/gui/askUserGui.m	0.00% <0.00%> (ø)
src/createDataDictionary.m	100.00% <0.00%> (ø)
src/gui/createQuestionList.m	100.00% <0.00%> (ø)
src/gui/getIsQuestionToAsk.m	100.00% <0.00%> (ø)
src/utils/removeDateSuffix.m	90.90% <0.00%> (ø)
src/gui/setDefaultResponses.m	100.00% <0.00%> (ø)
... and 2 more

---

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 cbb55a1...01c0736. Read the comment docs.

[Remi-Gau]

@CerenB @marcobarilari
I still need to update the actual sphinx documentation related to cfg. But you can already start looking into the new and "very small" help section of checkCFG.

[marcobarilari]

LGTM :)

[Remi-Gau]

@marcobarilari @CerenB

I updated the index.rst and created a set_up.rst and tried to move some of the content that was in the markdown in there.

Maybe have a look and let me know what you think.

[marcobarilari]

overall LGTM

[Remi-Gau]

overall LGTM

OK will merge then. I am fighting hard my inner perfectionist to keep improving this.

At least all of that gives us a better base to start from in general.