👋 Hey there, I am Waylon Walker
I am a Husband, Father of two beautiful children, Senior Python Developer currently working in the Data Engineering platform space. I am a continuous learner, and sha
Typically when I have a line that I need to comment on, I find that refactoring is necessary, then it almost reads as pseudo-code, and doesn't need a comment that needs to be updated with the code.
It also has a very good practice of making good clear docstrings that find there way into the documentation, and help text. This is where you tell users of your code how to use it, what it does (high level), and why. It does not need to be fully detailed, your code should be the details. realistically many libraries have more docs than they do code. especially when you add up all of the examples. But they do not document each line x=10 # setting x to 10
Some comments have been hidden by the post's author - find out more
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
This is why I like python.
Typically when I have a line that I need to comment on, I find that refactoring is necessary, then it almost reads as pseudo-code, and doesn't need a comment that needs to be updated with the code.
It also has a very good practice of making good clear docstrings that find there way into the documentation, and help text. This is where you tell users of your code how to use it, what it does (high level), and why. It does not need to be fully detailed, your code should be the details. realistically many libraries have more docs than they do code. especially when you add up all of the examples. But they do not document each line
x=10 # setting x to 10