aws / aws/jsii

(docs) incorrect module name in Python ScheduledFargateTask example

Open
#3,933 0 comments 0 reactions 0 assignees View on GitHub
bug documentation jsii p1
Dominant language
TypeScript
Stars
2.9k
Forks
267
Avg merge
1d 25m
Merged PRs (30d)
14

Description

### Describe the issue

The example code on this page

https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_ecs_patterns/ScheduledFargateTask.html

has the line

```python
scheduled_fargate_task_image_options=ecsPatterns.ScheduledFargateTaskImageOptions`
```

which should be

```python
scheduled_fargate_task_image_options=ecs_patterns.ScheduledFargateTaskImageOptions`
```

(the module name should be snake_case)

I assume this snippet is auto-translated (I don't see a Python version of this example in the repo) so probably an issue in the translator?

### Links

https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_ecs_patterns/ScheduledFargateTask.html

Contributor guide

Open the contributing guide

Research direction

Start with the ScheduledFargateTask example at the linked AWS CDK Python documentation page, then trace how that example is translated or generated because the issue notes that no Python version appears in the repository. Done means the generated example uses the snake_case ecs_patterns module name instead of ecsPatterns.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, typescript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.