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...
All content for UCL for Code in Research is the property of Peter Schmidt and is served directly from their servers
with no modification, redirects, or rehosting. The podcast is not affiliated with or endorsed by Podjoint in any way.
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...
3/9 Research Software Engineering with Python (Comp233) - Introduction to Python
UCL for Code in Research
25 minutes
1 month ago
3/9 Research Software Engineering with Python (Comp233) - Introduction to Python
Python is one of the most widely used programming languages in research and science. How did it come to that. And what makes Python special? It's something I discuss with my guest in this episode, Robin Wilson, who also takes us through some of the less favourable or more complex aspects of the language. Links http://www.rtwilson.com Robert Wilsonhttps://blog.rtwilson.com Robert's blog postshttps://www.python.orghttps://anaconda.org Anaconda Python distributionhttps://jupyter.org all thi...
UCL for Code in Research
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...
