microsoft / microsoft/debug-adapter-protocol
Clarify how `addressRange` is supposed to be represented in `Module` event
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.8k
- Forks
- 173
- Avg merge
- 7d 7h
- Merged PRs (30d)
- 2
Description
The spec says:
/**
* Address range covered by this module.
*/
addressRange?: string;
In the Module type
It's entirely unclear (from what I gather) how this is supposed to be represented and I haven't been able to find any of the other types, requests or events reference a range of addresses as just one string. I think this probably needs some clarification. Is it supposed to be 0xba5 .. 0xf00 or 0x123:0x456, or 0x123...0x456 or 0x123,+0x80 or any other of the many ways to do it? I think a uniform way would be preferable. But even if the spec doesn't desire a uniform way to represent an address range, it's probably best to at least mention that it's implementation defined.
Contributor guide
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 the Module type in the linked Debug Adapter Protocol specification and review the existing addressRange wording. Compare it with any address-range representations mentioned elsewhere in the specification or in this issue. Done means the specification explicitly defines the representation or states that it is implementation-defined.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100