search

SD2E / opil

The Open Protocol Interface Language (OPIL) is intended as a standard language for protocol interfaces
5 stars 1 forks source link

Properties: camelCase or snake_case? #102

Closed jakebeal closed 3 years ago

jakebeal commented 3 years ago

Writing up the OPIL spec, I notice that our properties have shifted from the camelCase pattern used by SBOL to the snake_case pattern used by Python. This means that documents will have a mix of snake case and camel case.
This feels inelegant, but not necessarily bad.

Example of the issue:

An ExperimentRequest uses sample_set to link to its SampleSet member. That SampleSet, being a subclass of CombinatorialDerivation, uses hasVariableFeature to link to its variables.

We should either:

  1. Change from snake_case to camelCase (but make sure the python mappings remain pythonic)
  2. Explicitly document and justify the disagreement of styles.
jakebeal commented 3 years ago

Following discussion, we're going to switch from snake_case to camelCase for the representation, but keep snake_case in the python API, just as with SBOL.

jakebeal commented 3 years ago

This has been resolved with #107