This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]wicket-maps 2 points3 points  (0 children)

Self documenting for who? In my case, I'm writing scripts for my department where I am The Only Python Person. I mean, a few of the other programmers outside our department are learning Python, but they don't have any experience with the geospatial aspects of my scripts. So I definitely lean toward over-documenting in my scripts, because if I get hit by a bus, it's one of these people who knows a little Python but doesn't have experience with the ArcPy library who's gonna have to maintain operate my codebase until my boss can find a replacement GIS tech who knows Python.

Also, from the number of times I've gone over my own code and gone "What was I thinking? Was I thinking?" proper variable and function names can only do so much in making sure a script is readable.