i think that there are some practical aspects to this request that could be 
explored, which might make it feasible to deliver over time

* netCDF enables the building of netCDF files from partial CDL, in particular 
array payloads not specified in the CDL are encoded as missing data

this would enable valid netCDF files to be encoded as CDL in the source tree, 
as plain text files, with any unnecessary array data left blank

such CDL files can be encoded into netCDF using the `ncgen` tool, enabling them 
to be used as example files

asciidoc's `include` directive enables partial inclusion of lines from another 
plain text file
https://urldefense.us/v3/__https://docs.asciidoctor.org/asciidoc/latest/directives/include/__;!!G2kpM7uM-TzIFchu!ikxGe72QWrOk7UsU90BG16YOvbIvouGbUFCKZGdbC3g1EbV7t52v4p4BY4-bSUE5I8eDWtuatm0$
 

These facets could enable the construction of an example file management 
process where:

1. an example CDL plain text file is stored in the cf-conventions source tree
2. the relevant snippets of that file are then used to populate the precise 
section of the conventions document that is required (delivering like for like 
comparison with current doc)
3. an automated action builds the CDL into NC as a pre-commit Pull Request test 
- assuring validity of CDL
4. an automated action builds the CDL into NC then validates with respect to CF 
conventions as a pre-commit Pull Request - assuring CF compliance

this work flow could fit quite neatly with the management process in place on 
this repository

if this is of interest, then we could try to prepare an example, with work 
flow, for consideration

i think that each example in the conventions doc would require some analysis to 
produce a valid CF CDL full file to subset to maintain content integrity.  So, 
we could investigate the work flow first with one example, then consider an 
ongoing activity to update (editorially) example snippets of CDL through the 
conventions document over time

hth marqh


-- 
Reply to this email directly or view it on GitHub:
https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/issues/348*issuecomment-1009000161__;Iw!!G2kpM7uM-TzIFchu!ikxGe72QWrOk7UsU90BG16YOvbIvouGbUFCKZGdbC3g1EbV7t52v4p4BY4-bSUE5I8eDjsdAgKw$
 
You are receiving this because you are subscribed to this thread.

Message ID: <cf-convention/cf-conventions/issues/348/[email protected]>
This list forwards relevant notifications from Github.  It is distinct from 
[email protected], although if you do nothing, a subscription to the 
UCAR list will result in a subscription to this list.
To unsubscribe from this list only, send a message to 
[email protected].

Reply via email to