Doc generation ignores that some packages don't exist in other languages
- Dominant language
- TypeScript
- Stars
- 12.9k
- Forks
- 4.6k
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 83
Description
### Describe the issue
I keep encountering random TypeScript code in CDK Python documentation. Is that because [jsii](https://github.com/aws/jsii) fails to translate the original code? It happens very often that I reference the official documentation and I find CDK construct arguments or Python libraries that don't exist.
One example is visible in the link provided in this issue, where the following line is used multiple times:
`from child_process import exec_sync`
The problem is that there is no `child_process` library in Python. I think the equivalent code would be:
`from subprocess import run`
### Links
docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_lambda_python_alpha/README.html
Contributor guide
Research direction
Start with the generated Python documentation at docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_lambda_python_alpha/README.html and compare its examples with the source documentation and jsii translation behavior. Done means cross-language documentation no longer includes imports or construct arguments that are unavailable in the target language.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100