opengeospatial / opengeospatial/bblocks-postprocess

How to document query functions?

Open
#56 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1
Forks
6
Avg merge
5d 10h
Merged PRs (30d)
3

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the existing building-block example at _sources/geof/is3D with vocabularies/functions.ttl and the GeoSPARQLBenchmark resources. Determine whether this repository supports URI-linked function documentation, SPARQL examples, results, and datasets, and whether executions should become tests. Done requires a maintainer decision and a recommended structure; the issue provides no concrete file or test target.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, testing
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.