Skip to content

Maintenance: set removeComments to false in tsconfig.json #1753

Closed
@dreamorosi

Description

Summary

A few weeks ago we changed our tsconfig.json file to adopt TypeScript 5.0 (#1672) and in doing so we inadvertently enabled the removeComments option from the compilerOptions. This caused the docstrings to be stripped from the built output.

We should set the option back to false so that comments are kept.

Why is this needed?

So that customers can get info and examples about methods in their IDEs when using Powertools.

Which area does this relate to?

Automation

Solution

No response

Acknowledgment

Future readers

Please react with 👍 and your use case to help us understand customer demand.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

Labels

completedThis item is complete and has been merged/shippedinternalPRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.)

Type

No type

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions