Add section to Guide_CLIMADA_Tutorial.ipynb #668
Conversation
Add a section in the guide doc/guide/Guide_CLIMADA_Tutorial.ipynb that specify to only use markdown instead of html to create tutorials.
| "\n", | ||
| "- follow the general CLIMADA naming convention for the notebook. For example: \"climada_hazard_TropCyclone.ipynb\"\n", | ||
| "\n", | ||
| "" |
There was a problem hiding this comment.
It is not part of this pull request, but why do we have this image here?
There was a problem hiding this comment.
Good question, I do not really know.. shall I remove it ? I added a space just because it was attached to the text.
| "2.\n", | ||
| "\n", | ||
| "\n", | ||
| "Lastly, the table of content should only contain headers of level 2 (##). Remember that links to headers are case sensitive!\n", |
There was a problem hiding this comment.
We should probably here indicate what "links to headers" are? How does one know what is the correct link for a given header?
There was a problem hiding this comment.
I added a few sentences to explain it, it should be more explicit now
|
Thanks, very useful! |
Co-authored-by: Chahan M. Kropf <chahan.kropf@usys.ethz.ch>
…roject/climada_python into feature/guide_tutorial
| "source": [ | ||
| "### Input:\n", | ||
| "\n", | ||
| "\n", |
There was a problem hiding this comment.
Nice picture - but I have trouble reading it (need to zoom in).
Wouldn't it be more useful to have it as plain text instead?
There was a problem hiding this comment.
@emanuel-schmid I agree it would be better with just text. I just didn't know how to write it without rendering the output. Since it is Markdown, it is interpreted as such and therefore converted to a table. Do you know how to write Markdown syntax without rendering the output ?
There was a problem hiding this comment.
@NicolasColombi : yes 😉 have a look at the changed guide
doc/guide/Guide_Continuous_Integration_and_Testing.ipynb
|
@emanuel-schmid : I think this is ready to merge right? |
Changes proposed in this PR:
PR Author Checklist
develop)PR Reviewer Checklist