Contribuyendo a la referencia de la clase¶
The class reference is available online in the classes section of the documentation and in the Godot editor, from the help menu.
En la referencia de clases, algunos métodos, variables y señales carecen de descripciones. Otros han cambiado con versiones recientes y necesitan actualizaciones. Los desarrolladores no pueden escribir toda la referencia por sí mismos. Godot te necesita a ti y a todos nosotros para contribuir.
Importante: Si planeas realizar cambios importantes, debes crear un problema (issue) en el repositorio godot-docs o comentar en un problema existente. De esta manera, otros sabrán que ya estás trabajando en una clase específica.
Ver también
Puedes encontrar las pautas de escritura para la referencia de clases aquí.
Para obtener más detalles sobre el uso de Git y el flujo de solicitud de extracción (pull request), consulta la página Flujo de trabajo para los Pull request.
Si deseas traducir la referencia de clases del inglés a otro idioma, consulta Localización del editor y de la documentación.
Esta guía también está disponible como un tutorial en video en YouTube.
Ver también
¿No estás seguro a qué clase contribuir? Echa un vistazo al estado de completitud de la referencia de clases aquí.
Puedes encontrar los archivos fuente para la referencia de clases en el repositorio de GitHub de Godot: doc/classes/.
Nota
Para algunos módulos en el código fuente del motor, encontrarás los archivos XML en el directorio modules/<nombre_del_modulo>/doc_classes/.
Advertencia
Always edit the API reference through these source XML files. Do
not edit the generated .rst files in the online documentation, hosted in the godot-docs repository.
Advertencia
A menos que realices cambios menores, como corregir un error tipográfico, no recomendamos utilizar el editor web de GitHub para editar el XML de la referencia de clases.
Le faltan funciones para editar el XML adecuadamente, como mantener las indentaciones consistentes, y no permite enmendar commits basados en revisiones.
Además, no te permite probar tus cambios en el motor ni con scripts de validación como se describe en Cómo editar una clase XML.
Actualizando plantilla de documentación¶
Cuando creas una nueva clase o modificas la API del motor, necesitas volver a generar los archivos XML en doc/classes/.
Para hacerlo, primero necesitas compilar Godot. Consulta la página Introducción al sistema de compilación para aprender cómo hacerlo. Luego, ejecuta el binario compilado de Godot desde el directorio raíz de Godot con la opción --doctool. Por ejemplo, si estás en Linux de 64 bits, el comando es:
./bin/godot.linuxbsd.tools.64 --doctool
Los archivos XML en doc/clases deberian estar actualizados con las características actuales de Godot Engine. Puedes verificar que fue modificado utilizando el comando git diff. Sólo incluye cambios que sean relevantes a tu trabajo sobre la API en tus commits. Puedes descartar cambios en otros archivos XML usando git checkout.