BlueBrain / libsonata

A python and C++ interface to the SONATA format
https://libsonata.readthedocs.io/en/stable/
GNU Lesser General Public License v3.0
11 stars 12 forks source link

Improvement for `Selection` documentation. #293

Open 1uc opened 11 months ago

1uc commented 11 months ago

From the documentation it's unclear to me if a libsonata.Selection can be unsorted, or contain duplicate elements. What happens if the arguments to the ctor are unsorted or contain duplicate elements? It would be helpful to make the documentation explicit in this regard. Regarding selection.ranges do I get a copy or just a reference?

"The documentation" refers to: https://libsonata.readthedocs.io/en/stable/#selection https://libsonata.readthedocs.io/en/stable/api.html#libsonata.Selection

mgeplf commented 11 months ago

Good points, I will make that more clear.