Aws-cdk: Generated Python docs infer incorrect type URL

Created on 19 Jan 2020  ·  5Comments  ·  Source: aws/aws-cdk

The link destination of the S3 Bucket parameter in the Python API reference is incorrect

The link destination of LifecycleRule parameter is aws_cdk.aws_ecr.LifecycleRule.
https://docs.aws.amazon.com/cdk/api/latest/python/aws_cdk.aws_ecr/LifecycleRule.html

I think it should be aws_cdk.aws_s3.LifecycleRule.
https://docs.aws.amazon.com/cdk/api/latest/python/aws_cdk.aws_s3/LifecycleRule.html

I'll be happy to fix it if I can, but are there any plans to contribute the documentation?


This is a 📕 documentation issue

bug docgenerated efformedium languagpython p2

All 5 comments

Hi @joe-king-sh, thanks for reporting this issue! 👍

I face this issue today.
this issue only in Python document.
TypeScript document is fine.

It looks like this issue is also being tracked in aws/jsii#1300.

I believe this is now fixed, so I'm resolving.

⚠️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.

Was this page helpful?
0 / 5 - 0 ratings