À PROPOS DE CET ÉPISODE
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.html
- https://wiki.python.org/moin/DocumentationTools
- https://peps.python.org/pep-0287/ reStructuredText Docstring Format
- https://github.com/matiassingers/awesome-readme some README examples
- https://www.gitkraken.com/learn/git/best-practices/git-commit-message GIT commit messaging
- https://www.warp.dev/terminus/git-commit-history Git Commit history
This podcast is brought to you by the Advanced Research Computing Centre of the University College London, UK.
Producer and Host: Peter Schmidt
Anglais
Royaume-Uni
TRANSCRIPTION 🔗
Are you the producer of this podcast?
Add a podcast transcript
Need Audio-to-Text?
Transcribe with Listen411 in Just 60 Seconds
RECHERCHER LES ÉPISODES PASSÉS
Rechercher les épisodes précédents de UCL for Code in Research.
AUTRES ÉPISODES DANS CE PODCAST
In this last episode of the companion podcast for the C++ course at UCL, I invited both Klaus Iglberger and Marc Hartung (Dive, Berlin) to go through some aspects of parallel computing. But also to look a little bit ahead of what's in store for C++ in future standards. And how the language may…
This first episode is about introducing C++, where it started, how it evolved. You will hear from 2 practitioners: Klaus Iglberger (C++ coach/trainer) and Marc Hartung (tech lead at Dive in Berlin).Here are a few links for you to follow up on:
https://www.stroustrup.com The Home Page of Bjarne Str…
Exceptions are essentials, as are error codes. Writes Bjarnes Stroustrup. And so on our 3rd stop through C++ I talk about what you could do when things go wrong. And what you can do to prevent errors - with testing. My guest is, again Klaus Iglberger.The sounds you're hearing are from the exce…
In the beginnings were...data and data types. Which is where we begin our journey through C++. The language provides for a range of interesting, fundamental, complex and custom types - one of which is a set of pointer types. My guest in this episode is Marc Hartung from Dive in Berlin, Germany.Link…
Peter Schmidt - the host of this podcast - interviews Sam Harrison, an environmental modeller at the UK Centre for ecology and hydrology. Is it version control important for his research? what tool does he use? How he learn it? Links and transcript available in the show notes.
About Sam
https://ww…
Avertissement: Le podcast et les illustrations intégrés sur cette page proviennent de Peter Schmidt, qui est la propriété de son propriétaire et n'est ni affilié ni approuvé par Listen Notes, Inc.
MODIFIER
Merci de nous avoir aidé à tenir la base de données de podcasts à jour.
