Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the storage interfaces from the user perspective #695

Open
francesshei opened this issue Mar 14, 2023 · 1 comment
Open

Document the storage interfaces from the user perspective #695

francesshei opened this issue Mar 14, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@francesshei
Copy link
Contributor

The label method docstring currently reads:

        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.

@Helveg
Copy link
Contributor

Helveg commented Jul 12, 2023

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 Helveg changed the title Improve PlacementSet.label docstring, in bsb.storage.interfaces Document the storage interfaces from the user perspective Mar 8, 2024
@Helveg Helveg added the documentation Improvements or additions to documentation label Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants