Skip to content

Commit

Permalink
chore(logs): fix for yarn build warning from log-group doc string (#3…
Browse files Browse the repository at this point in the history
…1587)

### Issue # (if applicable)

N/A

### Reason for this change
- New warning following #31535 regarding the docstring

### Description of changes
- update params in the docstring to match the function declaration

### Description of how you validated changes



### Checklist
- [ ] 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
michelle-wangg authored Sep 27, 2024
1 parent 54c01cb commit bdf1eef
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions packages/aws-cdk-lib/aws-logs/lib/log-group.ts
Original file line number Diff line number Diff line change
Expand Up @@ -321,8 +321,8 @@ abstract class LogGroupBase extends Resource implements ILogGroup {
/**
* Creates a CloudWatch metric for this log group.
*
* @param _metricName - The name of the metric to create.
* @param _props - Optional. Additional properties to configure the metric.
* @param metricName - The name of the metric to create.
* @param props - Optional. Additional properties to configure the metric.
* @returns A CloudWatch Metric object representing the specified metric for this log group.
*
* This method creates a CloudWatch Metric object with predefined settings for the log group.
Expand Down

0 comments on commit bdf1eef

Please sign in to comment.