search

SynBioDex / pySBOL3

Native python implementation of SBOL 3.0 specification
MIT License
37 stars 16 forks source link

Add example of using Range for SubComponent location #448

Closed PiotrZakrzewski closed 8 months ago

PiotrZakrzewski commented 8 months ago

I struggled to find out how to work with Location->Range as the docs do not mention it currently, so I thought I will contribute an example. I hope it helps! Let me know if you think other places need to be adjusted as well.

jakebeal commented 8 months ago

Thank you for the contribution --- I think that adding documentation of this sort is an excellent idea.

The current location that you are suggesting putting the example, however, doesn't quite fit in the structure of the documentation, as the "Getting started" page is focused on more generic concepts like "child objects"

What you are adding is an example that would work much better in a new documentation page that focuses on the SBOL3 data model, e.g., adapted from something like the pySBOL3 tutorial notebook at https://github.com/SynBioDex/SBOL-Notebooks/blob/main/iwbda_2023_examples.ipynb (which also doesn't currently have a really good Range example).

Would you be able to adjust your contribution to start building a page of that type?

PiotrZakrzewski commented 8 months ago

@jakebeal I made a draft for it here: https://github.com/SynBioDex/pySBOL3/pull/449 I will close this one (the linked PR replaces it)