LUMC DCC Coding Café November - Document your code

Join us at the Coding Café, the monthly meetup for everyone at LUMC who writes code for research: a short talk, then time to discuss questions and solve problems together.

Details

  • Locatie
    J-01-128
  • Organisator
    ADM

Omschrijving

This time: documenting your research code, so that a colleague (or you, a year from now) can understand and run it.

In this session you will:

  • write a README: what the code does, how to install and run it, and what input and output to expect
  • learn the layers of documentation: README, docstrings and comments, and what belongs where
  • use an AI assistant to draft documentation, and check what it gets wrong

Bring your laptop and your own code. We have cookies and coffee too.  

Meer informatie

LUMC DCC Coding Café November - Document your code