dart-lang / dart-lang/pub-dev

Document entity name/id + parentKey

Open
#2,959 2 comments 0 reactions 0 assignees View on GitHub
Type: enhancement
Dominant language
Dart
Stars
944
Forks
184
Avg merge
1d 15h
Merged PRs (30d)
12

Description

In our entities we are not good at documenting what the `Model.id` and `Model.parentKey` is.

We should go through all entities and make sure this is documented for each `Kind`.
(This is important, as this is how an entity is looked up).

Sometimes we also duplicate properties from the `id` and `parentKey` because we can query them without an ancestor key, we should also document all cases where data is duplicated and an invariant must be manually maintained.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.