Documenting Your Code with Python - Overview of Comments, Docstrings and Type Hints

Do you often look back at some code you wrote 6 months ago and scratch your head and wonder what this mess is? Or have you been passed a project that has been worked on by someone else and struggle to know where to start? If so you are not alone.
There are a number of ways in Python to help you understand the inner workings of your code, so that when you come back to it, it should be much easier to carry on where you left off. In this video I am going to cover how to improve your code by adding documentation, comments, and type hints.
⭐️ If you haven't already, make sure you subscribe to the channel: / @andymcdonald42
▼ --- SUPPORT THE CHANNEL --- ▼
☕️ BUY ME A COFFEE: www.buymeacoffee.com/andymcdo...
▼ --- TIMESTAMPS --- ▼
0:00 Introduction
0:20 The need for documentation
2:35 Comments in Python
5:40 Type Hinting
8:48 Docstrings in Python
12:55 Variable Naming
▼ --- RECOMMENDED BOOKS --- ▼
As an Amazon Associate I earn from qualifying purchases. By buying through any of the links below I will earn commission at no extra cost to you.
PYTHON FOR DATA ANALYSIS: Data Wrangling with Pandas, NumPy, and IPython
UK: amzn.to/3HNycJ9
US: amzn.to/3DL7qPv
FUNDAMENTALS OF PETROPHYSICS
UK: amzn.to/3l1PgSf
PETROPHYSICS: Theory and Practice of Measuring Reservoir Rock and Fluid Transport Properties
UK: amzn.to/30UNWZS
US: amzn.to/3DNqBbd
WELL LOGGING FOR EARTH SCIENTISTS
UK: amzn.to/3FHsbfn
US: amzn.to/3CILAuE
GEOLOGICAL INTERPRETATION OF WELL LOGS
UK: amzn.to/3l2v2HV
US: amzn.to/30UOTkU
▼ --- SOCIAL CHANNELS --- ▼
Thanks for watching, if you want to connect you can find me at the links below:
/ andymcdonaldgeo
/ geoandymcd
/ andymcdonaldgeo
www.andymcdonald.scot/
Be sure to sign up for my newsletter to be kept updated when I post and share new content on UA-cam and Medium.
www.getrevue.co/profile/andym...
#datascience #petrophysics #python

[@Identity_Withheld]

Thank you!

[@ColumbiaBasinJim]

Another great video. How do you decide when to use Jupyter Notebook & when to use a more traditional code editor?

[@TheMISBlog]

Very Informative video, Thanks Andy

[@vitorribeirosa]

Thanks, Andy!
Great content.

[@AndyMcDonald42]

Glad you liked it!