From the course: Learning ArcGIS Python Scripting
Join today to access over 24,400 courses taught by industry experts.
Creating help documentation for a script tool - ArcGIS Pro Tutorial
From the course: Learning ArcGIS Python Scripting
Creating help documentation for a script tool
- [Instructor] Whether you intend to share your scripts or just keep your scripts for yourself, you need to spend a few minutes to document their purpose and the proper way to use them. This makes it easy to come back to the script at any time in the future and run it or make updates to it. You can and should always document your script with a title block and pseudocode in the script as you're building it as you can see in this script. Early in the course, we learned that if your code is going to stay in a notebook, you can document it with markdown cells. So I'll insert a cell above, change the type to Markdown, and then I can just put text in here. If you remember, that markdown code isn't executed, it's just comments. But also remember we said if your code is going to be exported from notebooks and saved as a script that can be attached to a tool, then you should add the title block and pseudocode as comments in the script. Comments start with a hashtag. Comments are really great…
Practice while you learn with exercise files
Download the files the instructor uses to teach the course. Follow along and learn by watching, listening and practicing.
Download courses and learn on the go
Watch courses on your mobile device without an internet connection. Download courses using your iOS or Android LinkedIn Learning app.
