search

UCL / rsd-engineeringcourse

Course materials for Research Software Engineering course.
http://github-pages.ucl.ac.uk/rsd-engineeringcourse/
Other
108 stars 97 forks source link

Documentation page #97

Closed mattagape closed 5 years ago

mattagape commented 5 years ago

  1. In the line "Here's some Sphinx-generated output and the corresponding source code" the link to the source code doesn't work.

  2. breathe link is now https://breathe.readthedocs.io/en/latest/

  3. Roxygen link goes to a not-very-helpful RStudio page

  4. numpydoc Sphinx extension link is now https://numpydoc.readthedocs.io/en/latest/

  5. docstring Star Trek example does not have closing """

  6. The sphinx-quickstart link is broken.

ageorgou commented 5 years ago
  1. One thing missing from this page is why you would want to write documentation
  2. Comment-based Documentation tools: Lots of periods missing
  3. Write some docstrings: Missing """ to close docstring
dpshelio commented 5 years ago

Move it after writing libraries.

dpshelio commented 5 years ago

Good place to introduce doctests.