#406 · Markdown y documentos

Formateador de docstrings

Da una estructura uniforme a docstrings de Python y texto similar. Corrige espacios, conserva secciones como Args, Returns y Raises y produce un bloque limpio que puede reutilizarse en código o documentación.

Entrada de texto

Docstring
Espacio publicitario

Cómo usar esta herramienta de texto

  1. Pega o escribe el contenido en el área de entrada.
  2. Ajusta las opciones disponibles si necesitas cambiar el comportamiento.
  3. Pulsa el botón principal o usa Ctrl/Cmd + Enter.
  4. Revisa el resumen, las métricas y el resultado antes de copiarlo o descargarlo.

Qué hace esta herramienta

Procesa el contenido con reglas específicas del formato y genera una salida más estructurada o un análisis cuantificable.

El texto se divide en líneas, se reconocen patrones propios del formato y se reconstruye una salida consistente sin modificar identificadores técnicos.

El resultado se genera en tu navegador. Revisa siempre el contenido antes de publicarlo o usarlo en producción.

Ejemplo

Entrada:

"""Calcula el total.
Args:
  precio (float): precio base
  impuesto (float): tasa aplicada
Returns:
  float: total final
"""

Resultado: ejecuta el ejemplo incorporado para ver una salida verificable con las mismas reglas del procesador.

Casos de uso

  • Revisión rápida antes de publicar documentación.
  • Normalización de contenido pegado desde distintas fuentes.
  • Comprobación local sin depender de servicios externos.

Consejos para obtener mejores resultados

  • Usa una entrada suficientemente representativa.
  • Conserva una copia del original antes de reemplazar contenido.
  • Revisa nombres propios, código y valores sensibles tras el procesamiento.
  • Prueba casos límite si el resultado se integrará en un flujo automatizado.

Detalles del procesamiento

El procesamiento se ejecuta localmente con JavaScript y opera sobre el texto visible en el navegador. No requiere una API externa.

El análisis se basa en patrones y no sustituye un parser, compilador o detector especializado cuando se necesita validación normativa completa.

Preguntas frecuentes

¿El formateador funciona con docstrings de triple comilla simple y doble?

Sí. Conserva triple comilla simple si la entrada empieza así; en los demás casos utiliza triple comilla doble.

¿Reconoce secciones Args, Returns y Raises?

Sí. Esas secciones se cuentan y se conservan en la salida con sangría uniforme.

¿Valida que los parámetros de Args existan en la función Python?

No. La herramienta trabaja solo con el texto de la docstring y no analiza la firma de la función.

¿Puedo reducir líneas vacías repetidas en una docstring larga?

Sí. La opción de compactación elimina repeticiones innecesarias sin borrar el contenido textual.

¿La salida sigue exactamente Google Style, NumPy o Sphinx?

No de forma estricta. Aplica una normalización general; revisa convenciones específicas si tu proyecto exige un estilo concreto.

Resumen de módulos

MóduloFunción
EntradaTexto pegado, escrito o cargado desde archivo
ProcesamientoReglas específicas del tipo de herramienta
SalidaResultado copiable y descargable