Estoy tratando de crear algunas cajas de herramientas de Python para nuestra aplicación ArcMap (por ejemplo, MyTool.pyt)
Puedo ver que el texto de ayuda se define con el atributo self.description de las clases.
Sin embargo, una vez que ejecuto el programa, y hago clic en cualquiera de los campos de parámetros, el texto de ayuda/descripción queda vacío. Me gustaría poder proporcionar el campo de descripción para cada parámetro. ¿Cómo se consigue esto?
Después de algunas respuestas, veo que a través del menú contextual "Descripción del artículo" del botón derecho del ratón hay muchos campos que se pueden rellenar. ¿Existe una forma "pitónica" de hacer esto? Es decir, ¿simplemente incrustando algunos atributos en las clases del archivo .pyt?
Por ejemplo, en la definición de la caja de herramientas .pyt tienes la clase Toolbox:
import arcpy
class Toolbox(object):
def __init__(self):
"""Define the toolbox (the name of the toolbox is the name of the
.pyt file)."""
self.label = "My Toolbox"
self.alias = ""
# List of tool classes associated with this toolbox
self.tools = [MyNiceTool]
class MyNiceTool(object):
def __init__(self):
"""Define the tool (tool name is the name of the class)."""
self.label = "My Tool Class"
self.description = """
A description that shows up in the help context side pane when the tool is launched.
"""
self.canRunInBackground = True
def rest_of_required_methods....
Desde la cadena self.description la ventana de ayuda del diálogo de la herramienta mostrará este texto. Sin embargo, lo que quiero hacer es tener una "descripción" incrustada en mi código para cada parámetro también, de modo que cuando la herramienta se lanza, y el usuario hace clic en un campo de parámetro, la descripción del parámetro se muestra. Si tuviera que hacer esto usando el método 'Descripción de elementos' al que se hace referencia en las respuestas de abajo, editaría los campos Explicación del diálogo en la sección Sintaxis para cada parámetro... supongo.