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...
Parallel programming is a huge, exciting and evolving field. Together with my guest Marc Hartung from Dive in Berlin, Germany, we try to cover some aspects of it: including OpenMP, how to synchronise data etc. Links: https://en.cppreference.com/w/cpp/language/memory_model the C++ memory modelhttps://www.openmp.org OpenMP home pagehttps://www.openmp.org/resources/openmp-compilers-tools/ Compilers for OpenMPhttps://gcc.gnu.org/projects/gomp/ the GNU OpenMP compilerhttps://en.wikipedia.org...
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...
