How to document query functions?
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Ambito
- documentation, testing
Direzione di ricerca
Confronta l’esempio di building block esistente in _sources/geof/is3D con vocabularies/functions.ttl e le risorse di GeoSPARQLBenchmark. Determina se questo repository supporta la documentazione delle funzioni collegata tramite URI, gli esempi SPARQL, i risultati e i dataset, e se le esecuzioni dovrebbero diventare test. Per considerarlo completato sono necessarie una decisione di un maintainer e una struttura consigliata; l’issue non fornisce alcun file o target di test concreto.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- Python
- Stelle
- 1
- Fork
- 6
- Merge medio
- 23h 43m
- PR unite (30g)
- 7
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Nessun modello di pull request
- Nessuna guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di opengeospatial/bblocks-postprocess
-
Improve build strategyAperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
opengeospatial/bblocks-postprocess#102 · 12 commenti ·
-
if no bblocks highlighted, assume all are.Forse già presa @avillar l’ha presa 15 giorni fa. Aperta
opengeospatial/bblocks-postprocess#96 · 3 commenti · 1 assegnatario ·
-
Annotate output is not reproducible: properties[] order varies between runs on identical sourcesForse già presa @avillar l’ha presa 27 giorni fa. Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 56/100
opengeospatial/bblocks-postprocess#91 · 1 commento · 1 assegnatario ·
-
JSON schema library version review.Forse di nuovo libera @avillar l’ha presa 33 giorni fa e non c’è nessuna pull request aperta. Aperta
opengeospatial/bblocks-postprocess#89 · 3 commenti · 1 assegnatario ·
-
Test failures cannot distinguish advisory SHACL results (sh:Warning / sh:Info) from sh:ViolationForse già presa @avillar l’ha presa 2 giorni fa. Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 52/100
opengeospatial/bblocks-postprocess#88 · 2 commenti · 1 assegnatario ·
Tutte le issue di opengeospatial/bblocks-postprocess
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
microsoft/onnxscript#3155 ·
I maintainer di solito rispondono entro 4 giorni
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
I maintainer di solito rispondono entro 1 giorno
-
bug docs severity:low
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
I maintainer di solito rispondono entro 1 giorno
-
docs good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100