Documentaciónfuncion_ejemplos(db, modulo, funcion)

funcion_ejemplos(db,modulo,funcion)\texttt{funcion\_ejemplos}(db, modulo, funcion)

Nombre

funcion_ejemplos - Busca ejemplos relacionados con una funcion dentro de un modulo.

Sinopsis

tabla = docs.funcion_ejemplos(db, modulo, funcion)

Descripcion

Consulta la base documental y recupera ejemplos asociados a una funcion usando coincidencia de nombre dentro del modulo indicado.

Es util para:

  • mostrar ejemplos de uso
  • enlazar codigo .blox relacionado
  • complementar fichas documentales con casos practicos

Comportamiento

  • La busqueda se limita al modulo indicado.
  • El vinculo con la funcion se realiza por coincidencia de nombre.
  • Si no se encuentran ejemplos relacionados, retorna una tabla vacia.

Funciones API relacionadas

  • docs.funcion_info()
  • docs.funcion_argumentos()

Parámetros

ParámetroTipoDescripción
dbSQLITEHandle de conexion SQLite abierto sobre documentacion_blox.db.
moduloSTRINGClave del modulo.
funcionSTRINGNombre de la funcion.

Valor de retorno

TABLA - TABLA con los ejemplos encontrados. Cada registro incluye una etiqueta visible y la ruta del archivo fuente asociado al ejemplo.

Ejemplo

ejemplo.blox
TABLA resultado
resultado = docs.funcion_ejemplos(db, modulo, funcion)