search

linkml / linkml

Linked Open Data Modeling Language
https://linkml.io/linkml
Other
309 stars 95 forks source link

How to help people understand that the case of element names may be altered on doc pages #1734

Closed turbomam closed 3 months ago

turbomam commented 9 months ago

the nmdc-schema has a external_identifier type, but it is called ExternalIdentifier on the gen-doc page

sujaypatil96 commented 9 months ago

The documentation generator does a "silent repair" (on the web documentation side, not in the schema itself) and formats/renders the names of elements based on some of the implicit rules described here (not exhaustively): https://linkml.io/linkml/schemas/linter.html#standard-naming

Perhaps, a dedicated FAQ page/adding a section to an existing FAQ page to clarify all the element "repairs" that are happening would be helpful.

sujaypatil96 commented 6 months ago

Related FAQ entry: https://linkml.io/linkml/faq/modeling.html#why-are-my-class-names-translated-to-camelcase

turbomam commented 6 months ago

I think we should reciprocally link between that FAQ and https://linkml.io/linkml/schemas/linter.html#standard-naming

sierra-moxon commented 3 months ago

closing as complete.