Continuous Documentation for your Python code - Anastasiia Tymoshchuk

Published: 14 September 2022
on channel: PyCon SK
140
1

Do you document your code? Do you think it is important?

Imagine that you need to get back to your code in 6 month after you wrote it, there is always a big possibility that you will have to spend some time to find out how this code works. Or if someone else wrote some code, which is already in production and your task is to fix a bug in it and there is no documentation and no one actually knows what this code does.

There are more benefits of implementing continuous documentation for the code:

easy to onboard new team members,
easy to share knowledge,
if this code is open source - easy to start contributing,
easy to see purpose and motivation of each piece of code,
easy to keep versioning for each new release of the code.

It this talk I will show the difference between documentation types and will show a demo in the end of the talk.

https://2022.pycon.sk/sk/speakers/Ana...


On this page of the site you can watch the video online Continuous Documentation for your Python code - Anastasiia Tymoshchuk with a duration of hours minute second in good quality, which was uploaded by the user PyCon SK 14 September 2022, share the link with friends and acquaintances, this video has already been watched 140 times on youtube and it was liked by 1 viewers. Enjoy your viewing!