Skip to content

docs: removed unnecessary exports previously added to api docs #3000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 30, 2024

Conversation

am29d
Copy link
Contributor

@am29d am29d commented Aug 30, 2024

Summary

Changes

Please provide a summary of what's being changed

This PR removes not supported api docs annotations and reverts exports that were previously added. Instead we now use missing-exports plugin to collect all implicit exports in api docs.

Current api docs build looks clean:

> [email protected] docs-generateApiDoc
> typedoc .

[info] Loaded plugin typedoc-plugin-zod
[info] Loaded plugin typedoc-plugin-missing-exports
[info] Converting project at ./packages/commons
[info] Converting project at ./packages/jmespath
[info] Converting project at ./packages/logger
[info] Converting project at ./packages/metrics
[info] Converting project at ./packages/tracer
[info] Converting project at ./packages/parameters
[info] Converting project at ./packages/idempotency
[info] Converting project at ./packages/batch
[info] Converting project at ./packages/parser
[info] Merging converted projects
[info] Documentation generated at ./api

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

Issue number: closes #2993


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@am29d am29d requested a review from a team August 30, 2024 12:01
@am29d am29d requested a review from a team as a code owner August 30, 2024 12:01
@boring-cyborg boring-cyborg bot added batch This item relates to the Batch Processing Utility commons This item relates to the Commons Utility documentation Improvements or additions to documentation idempotency This item relates to the Idempotency Utility logger This item relates to the Logger Utility parameters This item relates to the Parameters Utility parser This item relates to the Parser Utility tracer This item relates to the Tracer Utility labels Aug 30, 2024
@pull-request-size pull-request-size bot added the size/M PR between 30-99 LOC label Aug 30, 2024
@am29d am29d self-assigned this Aug 30, 2024
@github-actions github-actions bot added do-not-merge This item should not be merged need-issue This PR needs an issue before it can be reviewed/worked on further labels Aug 30, 2024
Copy link

@aws-powertools aws-powertools deleted a comment from github-actions bot Aug 30, 2024
@am29d am29d removed do-not-merge This item should not be merged need-issue This PR needs an issue before it can be reviewed/worked on further labels Aug 30, 2024
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see that we've added the packages/testing in the typedoc.json file, but I don't see it in the build API docs outputs.

I just wanted to make sure the package does not end up in the published docs.

@am29d
Copy link
Contributor Author

am29d commented Aug 30, 2024

I see that we've added the packages/testing in the typedoc.json file, but I don't see it in the build API docs outputs.

I just wanted to make sure the package does not end up in the published docs.

I have added it to the exclude block.

@am29d am29d merged commit dab86a7 into main Aug 30, 2024
14 checks passed
@am29d am29d deleted the am29d/issue2993 branch August 30, 2024 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
batch This item relates to the Batch Processing Utility commons This item relates to the Commons Utility documentation Improvements or additions to documentation idempotency This item relates to the Idempotency Utility logger This item relates to the Logger Utility parameters This item relates to the Parameters Utility parser This item relates to the Parser Utility size/M PR between 30-99 LOC tracer This item relates to the Tracer Utility
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: add typedoc-plugin-missing-exports plugin to remove missing exports warnings
2 participants