Bioprotocols / labop-specification

Specification for the Laboratory Open Protocol Language (LabOP)
12 stars 3 forks source link

More user-friendly documentation about class properties #13

Open mszulcz-mitre opened 1 year ago

mszulcz-mitre commented 1 year ago

In the current version of the LabOP specification, it seems like finding what a class's properties are, whether they're required, and what their default values are can be difficult in some cases. For example, to find this information for the Protocol class, readers have to read through sections for 4 parent classes (uml:Activity, uml:Behavior, sbol:TopLevel, and sbol:Identified) and make a list for themselves.

Can the parameter-related information be easier to find? Maybe the section for each class could have an inclusive list in the form of a table. Of course, this would incur redundancy since parent-class parameters would be listed several times, but for me, the added convenience would be worth it.

danbryce commented 1 year ago

Thank you. This is a good suggestion. We also have several helper functions for each class that simplify access to the data attributes. We have a demo notebook (labop/notebooks/labop_demo.ipynb) that illustrates how to get the parameters for primitives. We anticipated end users would be most interested in those.

On Nov 4, 2022, at 12:22 AM, mszulcz-mitre @.***> wrote:

In the current version of the LabOP specification, it seems like finding what a class's properties are, whether they're required, and what their default values are can be difficult in some cases. For example, to find this information for the Protocol class, readers have to read through sections for 4 parent classes (uml:Activity, uml:Behavior, sbol:TopLevel, and sbol:Identified) and make a list for themselves.

Can the parameter-related information be easier to find? Maybe the section for each class could have an inclusive list in the form of a table. Of course, this would incur redundancy since parent-class parameters would be listed several times, but for me, the added convenience would be worth it.

— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you are subscribed to this thread.