Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

aws-rds: fromDatabaseInstanceAttributes static method missing #11817

Closed
cynicaljoy opened this issue Dec 1, 2020 · 2 comments · Fixed by #11979
Closed

aws-rds: fromDatabaseInstanceAttributes static method missing #11817

cynicaljoy opened this issue Dec 1, 2020 · 2 comments · Fixed by #11979
Assignees
@skinny85
Labels
@aws-cdk/aws-rds Related to Amazon Relational Database documentation This is a problem with documentation. effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. good first issue Related to contributions. See CONTRIBUTING.md p2

Comments

@cynicaljoy
Copy link

https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-rds.DatabaseInstance.html

The fromDatabaseInstanceAttributes method is missing from the generated documentation.

This is a 📕 documentation issue
@cynicaljoy cynicaljoy added documentation This is a problem with documentation. feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Dec 1, 2020
@skinny85 skinny85 added effort/small Small work item – less than a day of effort good first issue Related to contributions. See CONTRIBUTING.md p2 and removed needs-triage This issue or PR still needs to be triaged. labels Dec 1, 2020
@skinny85
Copy link
Contributor

skinny85 commented Dec 1, 2020

Thanks for opening the issue @cynicaljoy . I think that's because the fromDatabaseInstanceAttributes() method is actually incorrectly defined in the DatabaseInstanceBase class, instead of the DatabaseInstance class (and it's available in DatabaseInstance only because of JavaScript's/TypeScript's quirkiness).

A PR fixing this would be greatly appreciated 🙂.

@skinny85 skinny85 self-assigned this Dec 1, 2020
@skinny85 skinny85 added the @aws-cdk/aws-rds Related to Amazon Relational Database label Dec 1, 2020
ktheory added a commit to ktheory/aws-cdk that referenced this issue Dec 10, 2020
@ktheory
fix(rds): document DatabaseInstance.fromDatabaseInstanceAttributes me…
6f12b66 
…thod

Ensure `DatabaseInstance.fromDatabaseInstanceAttributes` is included in docs by moving it from the abstract `DatabaseInstanceBase` to the concrete `DatabaseInstance` class.

Thx @skinny85 for the suggestion in aws#11817.

Fixes aws#11817
@ktheory ktheory mentioned this issue Dec 10, 2020
Merged
ktheory added a commit to ktheory/aws-cdk that referenced this issue Dec 10, 2020
@ktheory
chore(rds): document DatabaseInstance.fromDatabaseInstanceAttributes …
243076f 
…method

Ensure `DatabaseInstance.fromDatabaseInstanceAttributes` is included in docs by moving it from the abstract `DatabaseInstanceBase` to the concrete `DatabaseInstance` class.

Thx @skinny85 for the suggestion in aws#11817.

Fixes aws#11817
@mergify mergify bot closed this as completed in #11979 Dec 15, 2020
mergify bot pushed a commit that referenced this issue Dec 15, 2020
@ktheory
chore(rds): document DatabaseInstance.fromDatabaseInstanceAttributes() (
f2ecaf2 
#11979)

Ensure `DatabaseInstance.fromDatabaseInstanceAttributes` is included in docs by moving it from the abstract `DatabaseInstanceBase` to the concrete `DatabaseInstance` class.

Thx @skinny85 for the suggestion in #11817.

Fixes #11817


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

flochaz pushed a commit to flochaz/aws-cdk that referenced this issue Jan 5, 2021
@ktheory @flochaz
chore(rds): document DatabaseInstance.fromDatabaseInstanceAttributes() (
54e68e9 
aws#11979)

Ensure `DatabaseInstance.fromDatabaseInstanceAttributes` is included in docs by moving it from the abstract `DatabaseInstanceBase` to the concrete `DatabaseInstance` class.

Thx @skinny85 for the suggestion in aws#11817.

Fixes aws#11817


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@skinny85 skinny85

Labels
@aws-cdk/aws-rds Related to Amazon Relational Database documentation This is a problem with documentation. effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. good first issue Related to contributions. See CONTRIBUTING.md p2
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(rds): document DatabaseInstance.fromDatabaseInstanceAttributes() ktheory/aws-cdk
2 participants
@cynicaljoy @skinny85