brainglobe / brainglobe/brainglobe-data-api-connectivity

`Connections` class design & metadata options

Open
#16 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
2
Forks
1
Avg merge
3d 13h
Merged PRs (30d)
2

Description

The `Connections` object is likely going to get a bit bloated, since all our central functionality will revolve around it. That in itself can't really be helped, but we might want to think of ways we can divide up the code into sensible chunks.

That being said, there are some more important considerations we should give to this class:

- We should provide an option for storing metadata about the connectivity information in the class itself. We'll also need an appropriate attribute for this too.
- The name `Connections` might not be the best we can do to describe what the class actually does.

Contributor guide

Open the contributing guide

Research direction

Start by locating the Connections class and reading how it currently represents connectivity information. Review related usages to determine where metadata and naming decisions would affect the API. Done requires an agreed design for metadata storage and a suitable class name, but the issue names no files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.