docs: improve introductory tutorial#2087
Conversation
EwoutH
left a comment
There was a problem hiding this comment.
Thanks, good catches!
Can this PR be merged or do you want to make other changes?
|
Depends on what your take on the two scientific references in the intro is. I have no strong preference (footnotes vs. keeping as is) either way. |
|
Hmm, no, actually I'd have expected something like that: As far as I can tell, this is also what it looks like in the readthedocs build for the PR. |
|
Yes, that's nice. Can we create a solution that also looks nice in the Jupyter notebook? |
|
Only by adding the The footnote text will only show up by hovering over the |
|
Maybe in that case I prefer a direct link to the papers (just |
That's a good idea for the papers: will adapt the tutorial accordingly. What about the footnotes detailing the |
|
Both ways are fine I think, I slightly prefer the readability of the notebooks over the docs, since they are mainly interactive tutorials. |
Fixes typos and header level error.
|
I've removed the footnote syntax changes (but kept some formatting corrections in the footnote text).
I've reconsidered here: Do we really want to do that? I think a reference as it currently stands is not so bad and provides more info than a simple URL could. I'd suggest to just keep those citations as is today. |
|
@EwoutH Is there anything else you'd want me to change to get this merged? |



This fixes
and also starts using the standard markdown footnote syntax. Since the latter is a bit of a bigger change (footnotes go to the end of the page), I put it in a separate commit. We could also consider using footnotes for the two scientific quotations, if so desired.