Skip to content
PodSubs
ShowsPeopleGuestsJobsNewsEvents
More
BlogPodCred
Menu
ShowsPeopleGuestsJobsNewsEventsBlogPodCredNetworksSign in
Join nowSign in
  • Shows
  • People
  • Jobs
  • News
  • More
    • Guests
    • Events
    • Blog
    • PodCred
    • Networks
    Join nowSign in

UCL for Code in Research

UCL for Code in Research artwork

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

Nov 16, 202617 minAudio
ShareXLinkedInFacebookWhatsAppEmail

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://docs.python.org/3/library/pydoc.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://dev.to/documatic/awesome-readme-examples-for-writing-better-readmes-3eh3 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 Don't be shy - say Hi This podcast is brought to you by the Advanced Research Computing Centre of the University College London, UK. Producer and Host: Peter Schmidt

Audio and video play straight from the show's own hosting. PodSubs stores and serves no media.

Hosts and Guests

Nobody is credited on this episode yet.

Credit the people on this episode

Be the first to rate this episode

More episodes

All episodes
  1. 5/9 Research Software Engineering with Python (COMP0233) - Testing with Python

    Nov 2, 202625 minAudio

    Testing your software is part of development. In this episode I talk about different types of testing, automated tests, legacy code etc. My guest is Stef Piatek from UCL who tells us how he approaches testing in his...

    Credit the people on this episode

  2. 4/9 Research Software Engineering with Python (COMP0233) - Data Formats

    Oct 26, 202625 minAudio

    In this episode I'll be discussing data formats such as CSV, JSON and YAML. My guest is Nick Radcliffe from Stochastic Solutions and the Uni. Edinburgh. Nick's expertise is in data science and he has a lot to share...

    Credit the people on this episode

  3. 3/9 Research Software Engineering with Python (COMP0233) - Introduction to Python

    Oct 19, 202625 minAudio

    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...

    Credit the people on this episode

  4. 2/9 Research Software Engineering with Python (COMP0233) - Git Part 2

    Oct 12, 202626 minAudio

    In this episode we look into more essential Git commands, such as branching and merging. Branching and merging are key concepts that help you develop code or even text documents in a team. They help you maintain...

    Credit the people on this episode

  5. 1/9 Research Software Engineering with Python (COMP0233) - Git Part 1

    Oct 5, 202621 minAudio

    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...

    Credit the people on this episode