How to document query functions?

Abierto
#56 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Estancado

Línea de trabajo

Compara el ejemplo de building block existente en _sources/geof/is3D con vocabularies/functions.ttl y los recursos de GeoSPARQLBenchmark. Determina si este repositorio admite documentación de funciones vinculada mediante URI, ejemplos de SPARQL, resultados y conjuntos de datos, y si las ejecuciones deberían convertirse en tests. Para darlo por terminado se requiere una decisión de un maintainer y una estructura recomendada; el issue no proporciona ningún archivo ni objetivo de test concretos.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

We are considering documenting the query functions of OGC GeoSPARQL using the building blocks environment.

I did not see any example of how to do that, so my question is:

Is building blocks meant for this in general?

I would like to document a query function by URI (in addition to the rainbow), provide a SPARQL query example, a sample (correct) query result and a test dataset on which the query could be executed.
It might look sth. liks this in my opinion: https://github.com/opengeospatial/ogc-geosparql/tree/13buildingblocks/_sources/geof/is3D

We have already prepared many of these resources for the GeoSPARQL compliance benchmark, including many correct and incorrect query executions:
https://github.com/OpenLinkSoftware/GeoSPARQLBenchmark/tree/master/src/main/resources

Also all functions including their parameters are already modeled in RDF:
https://github.com/opengeospatial/ogc-geosparql/blob/13buildingblocks/vocabularies/functions.ttl

So could building blocks be a way to document these functions and examples better or should query function executions actually become tests in the future which could be picked up by compliance benchmark implementations from the building blocks structure?

And if yes how would you recommend the documentation of query functions?

Let me know what you think and whether this is the right place to ask this.

Lenguaje dominante
Python
Estrellas
1
Forks
6
Merge medio
23 h 43 min
PR fusionados (30 d)
7

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de opengeospatial/bblocks-postprocess

Todos los issues de opengeospatial/bblocks-postprocess

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.