AllenInstitute / AllenInstitute/Teaching_Connectomics
Confusing switch in how annotations are stored
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
this link in module 3 uses the local annotations feature, as opposed to the proceeding links which are all hitting a live table and will update if someone clicks on a new cell. i saw someone get confused by this difference in behavior. is there a reason its necessary to switch to the local annotation here? It seems like the module just asks someone to zoom in on one of the dots so i dont see the local annotation features being used here. if it is necessary to keep it this way then i'd suggest clarifying in the module
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with module 3 and inspect the linked spelunker example alongside the preceding links to understand why it uses local annotations. Confirm whether the zoom-in activity depends on that behavior. Done means either documenting the reason for the switch in module 3 or clarifying the instructions so learners understand the different annotation storage behavior.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100