/
continuous-documentation-for-your-python-code.json
22 lines (22 loc) · 1.73 KB
/
continuous-documentation-for-your-python-code.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"copyright_text": null,
"description": "Continuous Documentation for your Python code - PyCon Italia 2022\n\nDo you document your code? Do you think it is important? Imagine that\nyou need to get back to your code in 6 month after you wrote it, there\nis always a big possibility that you will have to spend some time to\nfind out how this code works. This talk will tell you a secret trick\nabout documentation. Do you document your code? Do you think it is\nimportant?\n\nImagine that you need to get back to your code in 6 month after you\nwrote it, there is always a big possibility that you will have to spend\nsome time to find out how this code works. Or if someone else wrote some\ncode, which is already in production and your task is to fix a bug in it\nand there is no documentation and no one actually knows what this code\ndoes.\n\nThere are more benefits of implementing continuous documentation for the\ncode:\n\n- easy to onboard new team members,\n- easy to share knowledge,\n- if this code is open source - easy to start contributing,\n- easy to see purpose and motivation of each piece of code,\n- easy to keep versioning for each new release of the code.\n\nIt this talk I will show the difference between documentation types and\nwill show a demo in the end of the talk.\n\nSpeaker: Anastasiia Tymoshchuk\n",
"duration": 1382,
"language": "eng",
"recorded": "2022-06-03",
"speakers": [
"Anastasiia Tymoshchuk"
],
"tags": [
"best practice",
"documentation"
],
"thumbnail_url": "https://i.ytimg.com/vi/xlzultL8gno/maxresdefault.jpg",
"title": "Continuous Documentation for your Python code",
"videos": [
{
"type": "youtube",
"url": "https://www.youtube.com/watch?v=xlzultL8gno"
}
]
}