aws / aws/jsii

Allow property JSDoc overloading

Open
#869 2 comments 2 reactions 0 assignees View on GitHub
documentation effort/medium feature-request p2
Dominant language
TypeScript
Stars
2.9k
Forks
267
Avg merge
1d 25m
Merged PRs (30d)
14

Description

## :rocket: Feature Request

### Affected Languages

- [x] `TypeScript` or `Javascript`
- [x] `Python`
- [x] `Java`
- [x] .NET (`C#`, `F#`, ...)

### General Information
* **JSII Version:** 0.18.0
* **Platform:** all

* [ ] I may be able to implement this feature request
* [ ] This feature might incur a breaking change

### Description

JSII throws an error when attempting to overload an interface property to change its child JSDoc: (`Interface declares same member as inherited interface`)

* CDK use-case: [#4299 #b3597407a1217ae035772227048a21fb89896591](https://github.com/aws/aws-cdk/pull/4299/commits/b3597407a1217ae035772227048a21fb89896591)
* [Failed build log](https://cdk-master-autobuildgithubcodebuildlogs-buildlogs-x1pc7ou2lliz.s3.amazonaws.com/ebffcbad-11bd-4ef0-a73c-22a0caf56f6c/build.log?AWSAccessKeyId=ASIATZM3T7QUBLGVEY6K&Signature=lo2OULHijUS%2B0KHy1HNhZ%2BbQz%2FY%3D&x-amz-security-token=AgoJb3JpZ2luX2VjEKv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJIMEYCIQD3DWgEulK42gaZvsfP%2FShGGyZgoWyvAckjB9bkxY0hcQIhANdsx%2FAwxPm3tbzcoip44kxeGaIx5y0%2B7vrGPoKVNWt1KsUCCJT%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQARoMMjYwNzA4NzYwNjE2IgwsufTsnaCr8Sb9ZG8qmQJnhKjgVLi633i5rlqk7%2FsnlIxUA9YlMWgXNshdt4CJqkSipBUP8yexyOf9kzT2ZPXZa%2BfrEvJaPDhb88KAi%2BRKRtwZ%2F348C8UMlpySTMMxh0UIyBkce975uOPCt2JIw6HZFb%2F5KxDTQS8MjhEpSFdHFsa9owSmFN251dTcTSxcOIOanaSTn2hxmZbTRxYdwQpNS5cbV4YrD59QXYI1B0JCbd5fhRbRfiyjAqfYq7kUm3jrmXgzb3oIraSJLzBznofRztRNk90tL5jgttN8XvWKxcGOD%2Fk4LjXgdEGYkDu1tm%2Fwpoe%2FmdY0gEGIsrgWKHozKqi%2FmncPEoZBV2OxnAXc64M4fY8T821enUdT%2FVTCp90XCAwAoq5buzD8r%2FPsBTqzAcUCd%2BPvNPrFZ1Gq02lcUE7YwCd6beaDS4XHkpye2FuqTjP5VLe3Z3DeBoDIYW2YuOcMvHoumR7goiUFE05HBRcgs%2FdgcA84S2HtMSgydNtlqzqu9Kf5raAV%2BO%2B9z7ZIy1v%2FGypNzsxZyHiYCBQgNSfwiGDAXq5rHTGPP%2BTq2%2B2bgfZgTCiwT3hDduE1jp9iPul2t5eswlmqGPtNG1xXb836oa9SJqEuBYtkKorFjkGhP%2BqI&Expires=1570560910)

### Proposed Solution
`_visitDocumentation` could be used to check that the parent and child docs are different, and not throw if that's the case.

Contributor guide

Open the contributing guide

Research direction

Locate the _visitDocumentation entry point mentioned in the proposal and trace the validation that raises "Interface declares same member as inherited interface." Reproduce the CDK-related failure if possible, then verify that a child property with different JSDoc is accepted without weakening the existing duplicate-member check.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, java, javascript, python, typescript
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 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.