Skip to content

Commit

Permalink
chore(glue): fix broken link (#31994)
Browse files Browse the repository at this point in the history
### Issue # (if applicable)

None

### Reason for this change

The generated document is broken due to an incorrect format.

```ts
@see https://example.com Some redundant phrases
```

<img width="1398" alt="スクリーンショット 2024-11-02 20 00 25" src="https://github.com/user-attachments/assets/b29dc368-c44f-4f2b-a95b-9e2651f96ef1">

### Description of changes

Remove redundant description.

### Description of how you validated changes

None

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
badmintoncryer authored Nov 4, 2024
1 parent 5fca268 commit 6190c14
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions packages/@aws-cdk/aws-glue-alpha/lib/job.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export class WorkerType {
/**
* Job states emitted by Glue to CloudWatch Events.
*
* @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types for more information.
* @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types
*/
export enum JobState {
/**
Expand Down Expand Up @@ -583,7 +583,8 @@ export interface JobProps {
/**
* The default arguments for this job, specified as name-value pairs.
*
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html for a list of reserved parameters
* @see https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
*
* @default - no arguments
*/
readonly defaultArguments?: { [key: string]: string };
Expand Down

0 comments on commit 6190c14

Please sign in to comment.