6/9 Research Software Engineering with Python (COMP233) - Documentation

Documentating software is part of the life of software engineers. But what kind of documentation do we need? In this episode I take you through three levels of documentation: the basic README and LICENSE files everyone should have, how to be good at writing git commit messages and using tools to turn your source code comments into browsable documentation.Linkshttps://www.sphinx-doc.org/https://pdoc.dev/docs/pdoc.htmlhttps://docs.python.org/3/library/pydoc.htmlhttps://wiki.python.org/moin/DocumentationToolshttps://peps.python.org/pep-0287/ reStructuredText Docstring Formathttps://github.com/matiassingers/awesome-readme some README exampleshttps://dev.to/documatic/awesome-readme-examples-for-writing-better-readmes-3eh3https://www.gitkraken.com/learn/git/best-practices/git-commit-message GIT commit messaginghttps://www.warp.dev/terminus/git-commit-history Git Commit historyDon't be shy - say HiThis podcast is brought to you by the Advanced Research Computing Centre of the University College London, UK. Producer and Host: Peter Schmidt