You are here:

Anatomy of a tool reference page

To provide you with a familiar tool documentation experience, G2 Integrated Solutions (G2‑IS) has adopted Esri’s documentation guidelines and structure. Every tool page in the tool reference adheres to this same Esri documentation structure; understand the structure, and you’ll be able to use any tool with ease.

Elements of a tool reference page

Whether you search for a tool page or browse to it by expanding its toolbox, followed by its toolset, and clicking to load its page, here’s what you’ll find:

Summary

The Summary is a short description of what the tool does. It may contain links to more in-depth information about how the tool works. In some cases, the summary will be followed by an illustration that also explains what the tool does.

Usage

The Usage section contains notes and clarifications about using the tool. When the notes refer to a particular tool parameter, the parameter label, which appears on the tool dialog box, is used rather than the parameter name, which appears in the syntax and is used in Python. The relationship between the parameter’s label and name is usually obvious, but, in some cases, the parameter name is noted to avoid confusion.

Syntax (includes list of parameters)

The Syntax section provides the format and set of parameters that are required to execute the tool in Python. It is followed by a table that lists all the parameters with their names, explanations, and the data (value) types. See Tool syntax decoded for a detailed explanation of this section of a tool reference page.

Code sample

The Code sample section includes one or more examples that illustrate how the tool can be executed and used in Python.

Environments

The Environments section is a list of the environment settings that the tool honors. Click any link in the list to go to its Esri reference page. If a particular environment setting is of importance to the tool, there may be further information about that setting.

Licensing information

The Licensing information section provides information about how the tool is licensed under the G2-IS license management system.

Related topics

The Related topics section provides you with a set of helpful links to additional help topics related to the tool.