docs(core): drop stale `sep` reference from `ArnComponents.arnFormat` default docs by ManoharPaturi · Pull Request #38775 · aws/aws-cdk · GitHub
Skip to content

docs(core): drop stale sep reference from ArnComponents.arnFormat default docs - #38775

Open
ManoharPaturi wants to merge 1 commit into
aws:mainfrom
ManoharPaturi:fix-arnformat-default-docs
Open

docs(core): drop stale sep reference from ArnComponents.arnFormat default docs#38775
ManoharPaturi wants to merge 1 commit into
aws:mainfrom
ManoharPaturi:fix-arnformat-default-docs

Conversation

@ManoharPaturi

@ManoharPaturi ManoharPaturi commented Sep 4, 2026

Copy link
Copy Markdown

Body:

Fixes #38763

Summary

The arnFormat property documentation on ArnComponents (which surfaces as
the arn_format parameter docs of Stack.format_arn in the generated
Python/API docs) stated:

Default: - uses value of sep as the separator for formatting,
ArnFormat.SLASH_RESOURCE_NAME if that property was also not provided

sep is a deprecated property and does not appear on the generated Python
surface, so the reference is dangling there. This changes the default text
to state the effective modern default directly:

Default: - ArnFormat.SLASH_RESOURCE_NAME

No code change — Arn.format behavior is untouched (sep still takes
precedence when explicitly provided, as documented on the property itself).

Copilot AI lite review requested due to automatic review settings September 4, 2026 18:27
@ManoharPaturi
ManoharPaturi requested a review from a team as a code owner September 4, 2026 18:27
@github-actions github-actions Bot added effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 labels Sep 4, 2026
@github-actions github-actions Bot added the beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK label Sep 4, 2026
@aws-cdk-automation
aws-cdk-automation requested a review from a team September 4, 2026 18:27
Copilot AI reviewed Sep 4, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The change is documentation-only, matches the current default behavior in Arn.format, and addresses the reported generated-docs mismatch without altering runtime behavior.

Pull request overview

This PR fixes AWS CDK v2 API documentation for ArnComponents.arnFormat so generated docs (notably Python’s Stack.format_arn parameter docs) no longer reference the deprecated sep property that is not present on the Python surface.

Changes:

  • Update ArnComponents.arnFormat JSDoc @default text to directly state ArnFormat.SLASH_RESOURCE_NAME.
  • Remove the dangling documentation reference to deprecated sep (while leaving runtime behavior unchanged).
File summaries
File Description
packages/aws-cdk-lib/core/lib/arn.ts Adjusts ArnComponents.arnFormat default documentation to avoid referencing deprecated sep in generated API docs.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

aws-cdk-automation
aws-cdk-automation previously requested changes Sep 4, 2026
View reviewed changes

@aws-cdk-automation aws-cdk-automation left a comment •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(This review is outdated)

@ManoharPaturi ManoharPaturi changed the title fix(aws-cdk-lib): ArnComponents.arnFormat default docs no longer reference the deprecated sep fix(aws-cdk-lib): drop stale sep reference from ArnComponents.arnFormat default docs Sep 4, 2026
@ManoharPaturi

ManoharPaturi commented Sep 4, 2026

Copy link
Copy Markdown
Author

@ManoharPaturi
fix(aws-cdk-lib): ArnComponents.arnFormat default docs no longer refe…
5718703 
…rence the deprecated sep

Signed-off-by: ManoharPaturi <186662190+ManoharPaturi@users.noreply.github.com>
@ManoharPaturi
ManoharPaturi force-pushed the fix-arnformat-default-docs branch from 8ef233e to 5718703 Compare September 4, 2026 18:38
@aws-cdk-automation aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Sep 4, 2026
@aws-cdk-automation aws-cdk-automation mentioned this pull request Sep 4, 2026
Closed
@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Sep 7, 2026
@ManoharPaturi ManoharPaturi changed the title fix(aws-cdk-lib): drop stale sep reference from ArnComponents.arnFormat default docs docs(core): drop stale sep reference from ArnComponents.arnFormat default docs Sep 17, 2026
@aws-cdk-automation
aws-cdk-automation dismissed their stale review September 17, 2026 17:38

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

@aws-cdk-automation aws-cdk-automation mentioned this pull request Sep 17, 2026
Closed

This branch was previously deployed

1 inactive deployment
automation — 57187031 Deployed Sep 17, 2026 by ManoharPaturi via validate-pr #368225
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@aws-cdk-automation aws-cdk-automation aws-cdk-automation left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

aws_cdk: Stack.format_arn mentions non-existent sep parameter

3 participants

@ManoharPaturi @aws-cdk-automation