aws / aws/aws-cdk

aws_cdk: Stack.format_arn mentions non-existent sep parameter

Open Beginner friendly
#38,763 1 comment 0 reactions 0 assignees View on GitHub
documentation effort/small feature-request p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
1d 19h
Merged PRs (30d)
74

Description

### Describe the issue

The documentation for the `arn_format` parameter to `Stack.format_arn` currently states:

> The specific ARN format to use for this ARN value. Default: - uses value of sep as the separator for formatting, ArnFormat.SLASH_RESOURCE_NAME if that property was also not provided

However, there is no `sep` property.

### Links

https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk/Stack.html#aws_cdk.Stack.format_arn

Contributor guide

Open the contributing guide

Research direction

Start at the Stack.format_arn entry point and compare the arn_format parameter documentation with the API page linked in the issue. Remove or correct the reference to the nonexistent sep property, then regenerate or inspect the resulting documentation to confirm the description no longer mentions it.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.