fix doc fishr display

[lisab00]

display of latex equations in doc fishr is not correct

[lisab00]

@smilesun do you have any idea why the display equations do not render in the documentation https://github.com/marrlab/DomainLab/blob/master/docs/docFishr.md (e.g. line 25-27 in the code)?
I created the code with texworks editor, where the equations displayed correctly...

[smilesun]

Hi, Lisa, I think your documentation is really high quality, but I have not the time budget yet to look at the error, this would be less prioritized then.

[smilesun]

@agisga , do you know?

[agisga]

@agisga , do you know?

Not sure if it will fix the entire issue, but there are some $$ symbols missing, for instance:

• " §§\theta$$ denote "
• "$$\mathcal{R}_e(\theta) be the ERM"

[lisab00]

No problem if you have no time, it's not a priority.
I already fixed the issue you mention here.

Not sure if it will fix the entire issue, but there are some $$ symbols missing, for instance:

• " §§\theta$$ denote "
• "$$\mathcal{R}_e(\theta) be the ERM"

I am just talking about the display equations (like in line 25-27 in the md file)

[agisga]

I am just talking about the display equations (like in line 25-27 in the md file)

I'm not sure what latex renderer is being used here, but with the most common latex interpreters, if a dollar sign is missing anywhere in the document, then it can mess up the formatting everywhere in the rest of the document (like if you open an $$ in some line but never close it, then it may be assumed that the whole rest of the document is one long equation)... I think it's like with any type of programming, a bug in one line can lead to an error in an entirely different line. So, in my opinion, I would strongly suggest to fix the syntax everywhere, not just lines 25-27...

[lisab00]

I am just talking about the display equations (like in line 25-27 in the md file)

I'm not sure what latex renderer is being used here, but with the most common latex interpreters, if a dollar sign is missing anywhere in the document, then it can mess up the formatting everywhere in the rest of the document (like if you open an $$ in some line but never close it, then it may be assumed that the whole rest of the document is one long equation)... I think it's like with any type of programming, a bug in one line can lead to an error in an entirely different line. So, in my opinion, I would strongly suggest to fix the syntax everywhere, not just lines 25-27...

Alright I understand, thank you very much! @agisga

[codecov-commenter]

Codecov Report

Merging #372 (f44ddd4) into master (2331d1d) will increase coverage by 0.04%.
Report is 181 commits behind head on master.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #372      +/-   ##
==========================================
+ Coverage   95.22%   95.27%   +0.04%     
==========================================
  Files         129      132       +3     
  Lines        4464     4720     +256     
==========================================
+ Hits         4251     4497     +246     
- Misses        213      223      +10     

Flag	Coverage Δ
unittests	95.27% <ø> (+0.04%)	⬆️

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

Files	Coverage Δ
domainlab/models/model_diva.py	97.61% <ø> (ø)
domainlab/utils/hyperparameter_gridsearch.py	100.00% <ø> (ø)

... and 17 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[lisab00]

display is now fixed: https://github.com/marrlab/DomainLab/blob/lb_fix_doc_fishr/docs/docFishr.md