Skip to content
Arnau Valladares-Esteban edited this page Jan 27, 2021 · 8 revisions
  • Each Tutorial should contain a Table of Contents at the beginning with links to main sections.
  • Only the main sections (one #) of the tutorial need to appear on the Table of Contents.
  • Tutorials should be self-contained.
  • Whenever writing text in a Jupyter Notebook, use only Markdown and Latex equations. Avoid (as much as possible) the use of HTML.
  • Markdown language offers a neat way to write pseudo-code. See this question at StackOverflow.
  • Do not organize references as you would in a Latex document, use hyperlinks and information in brackets, instead.
  • Avoid linking other resources of the course like slides or example code provided in StudyNet.
  • There is a folder named imgs where you can store image files to display in your tutorial. The naming convention should follow NN_BriefDescription.png where NN is the number of your tutorial.
  • Avoid linking images directly from a website. Download the image and store it in the imgs folder. Use and name these images properly.
  • Use as few cells as possible. For example, when writing Markdown, you do not need to use one cell for the title of a section and another cell the text of the section. Write both in the same cell.
  • Do not numerate the sections. Simply use the amount of # to establish the appropriate hierarchy among sections.
  • Pay attention to the quality of your writing.
  • Quality (not quantity/length) is the only decisive factor towards your grade.
Clone this wiki locally