You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Should label the cells with given labels.
:param cells: Array of cells in this set to label.
:type cells: numpy.ndarray
:param labels: List of labels
:type labels: list[str]
Could be useful to explicitly state that the function assigns each label in the list to each cell.
The text was updated successfully, but these errors were encountered:
This docstring is for the interface of PlacementSet, aimed at developers trying to implement their own PlacementSet for a new storage engine. In that case, they should know that this function should label the cells with given labels.
That said, encountering this docstring in the BSB docs as a user is quite confusing. Instead of linking to the bsb.storage.interfaces.PlacementSet, we should link to bsb_hdf5.PlacementSet as the de facto default implementation.
Helveg
changed the title
Improve PlacementSet.label docstring, in bsb.storage.interfaces
Document the storage interfaces from the user perspective
Mar 8, 2024
The
label
method docstring currently reads:Could be useful to explicitly state that the function assigns each label in the list to each cell.
The text was updated successfully, but these errors were encountered: