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

About this episode

This episode discusses the importance of software documentation and the different levels of documentation needed for software engineers.

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. Links https://www.sphinx-doc.org/https://pdoc.dev/docs/pdoc.htmlhttps://docs.python.org/3/library/pydoc.htmlhttps://wiki.python.org/moin/Do...

People in this episode

Host: Peter Schmidt

Topics covered

• software documentation
• software engineering
• Python
• git commit messages
• source code comments

Keywords

• documentation
• README
• LICENSE
• git commit messages
• browsable documentation

Mentioned in this episode

Organizations: Python, Sphinx, pdoc, Git

More episodes of UCL for Code in Research

• 5/10 Classes and Design [2026] · February 18, 2026 · 34 min
• 4/10 On Polymorphism [2026] · February 11, 2026 · 27 min
• 3/10 Throw, try, catch...test [2026] · February 4, 2026 · 32 min
• 2/10 Data Types and the world of (smart) pointers [2026] · January 28, 2026 · 35 min
• 1/10 C++ - An Introduction [2026] · January 21, 2026 · 38 min
• 9/9 Research Software Engineering with Python (COMP233) - Performance · December 11, 2025 · 23 min