INCATools / dead_simple_owl_design_patterns

A simple system for specifying OWL class design patterns for OBO-ish ontologies.
http://incatools.github.io/dead_simple_owl_design_patterns/
GNU General Public License v3.0
42 stars 5 forks source link

Simplify generated schema doc #75

Open dosumis opened 3 years ago

dosumis commented 3 years ago

The current autogenerated schema doc is overly complicated in the sections that deference definitions.

This would be sufficient:

Note lack of reference names internal to pattern (no printf_owl). This makes sense - a semantically identical pattern could be written with all of the nested structure explicitly repeated under every primary property. I don't see any need for quoting.

I may be wrong, but I also think it is sufficient to just list type (string or list) in brackets, inferring that a list of sets of the keys nested underneath are permitted, rather than including an 'items' keyword.

Deal with recursive structure implicitly by using an ellipsis at the first level of recursion.

dosumis commented 3 years ago

Note - above should be compatible with mkdocs (I think)

hkir-dev commented 3 years ago

Schema documentation simplification completed: https://github.com/INCATools/dead_simple_owl_design_patterns/blob/pypi_release/src/schema/dosdp_schema.md