dart-lang / dart-lang/webdev

`@Function`, `@Field`, and `@Class` responses should include populated `location`

Open
#1,428 4 comments 0 reactions 0 assignees View on GitHub
P3 package:dwds symbols triaged
Dominant language
Dart
Stars
224
Forks
94
Avg merge
7h 14m
Merged PRs (30d)
2

Description

The `location` property for `@Function`, `@Field`, and `@Class` is technically marked as optional in the specification for legacy reasons, but should always be provided in order to allow for these objects to be associated with a parent script. Having location information also allows for us to determine where the code is in a script without having to request the full object.

This is blocking program explorer from working correctly with dwds.

Contributor guide

Open the contributing guide

Research direction

Start by tracing how responses for @Function, @Field, and @Class are produced and how their location property is populated. Compare the implementation with the specification and check the DWDS program explorer behavior; done means each response includes location information sufficient to associate the object with its parent script and locate its code without requesting the full object.

Written by the indexing model from the issue text.

Assessment

Tech stack
dart
Domain
backend-api-design
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.