hypothesis / hypothesis/client

Review the usage of `Annotation` type across the app

Open
#5,659 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Mustache
Stars
730
Forks
224
PR merge metrics
No merged PRs in 30d

Description

During https://github.com/hypothesis/client/pull/5658, it was made obvious we need to review how we use the `Annotation` type to represent annotations.

After that, we now have two independent types, the `APIAnnotationData`, which represents an annotation as served/consumed by h API, and `ClientAnnotationData`, which represents the extra attributes added by the client for internal logic.

Then we have the main `Annotation` type which is a combination of both.

For simplicity and historical reasons, the `Annotation` one has been used everywhere, but we need to make a pass over the code and try to be as granular as possible, making sure we narrow down types to `APIAnnotationData` or `ClietnAnnotationData` if applicable.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.