qzx createDocTemplatePython

Ejemplo de salida representativa

Este JSON ilustrativo deriva del contrato de resultado respaldado por la implementación actual. Muestra lo que el comando puede devolver sin afirmar que es una ejecución grabada; los valores varían según entradas, equipo, permisos y herramientas opcionales.

Comando del ejemplo: qzx CreateDocTemplatePython myfile.py --json

{
    "success": true,
    "message": "Creates basic documentation templates for Python code that lacks docstrings. In this illustrative example, the command completed successfully.",
    "changes_made": true,
    "changes_preview": [
        "Add a module docstring.",
        "Document the public function."
    ],
    "file_path": "C:\\project\\example.txt",
    "overwrite": true,
    "preview": true,
    "stats": {
        "summary": "Additional structured context is included here."
    },
    "style": "Example value"
}

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "changes_made": {
            "type": "boolean"
        },
        "changes_preview": [],
        "error": {
            "type": "string"
        },
        "file_path": [],
        "overwrite": [],
        "preview": [],
        "stats": [],
        "style": []
    },
    "additionalProperties": true
}

Errores y límites

El contrato público exige success=false y un message descriptivo en fallos. Este catálogo aún no declara una taxonomía de errores específica para cada comando; revisa el resultado y no infieras códigos inexistentes.

QZX está en alpha. Dependencias opcionales, permisos y capacidades del host pueden cambiar el resultado.

Flujo de evidencia: requiere un destino desechable aislado.