Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs(idempotency): review API docs & README #2917

Merged
merged 12 commits into from
Aug 13, 2024
Merged

docs(idempotency): review API docs & README #2917

merged 12 commits into from
Aug 13, 2024

Conversation

am29d
Copy link
Contributor

@am29d am29d commented Aug 13, 2024 •
edited
Loading

Summary

Changes

Please provide a summary of what's being changed

This PR overhauls the JSDoc comments on each type, function, class, and method of the Idempotency utility so that it provides better and relevant info to customers using the API docs or wanting to get contextual info within their IDE.

The work here followed the guidelines established in the linked issue and its parent, and also refreshes the README file for the utility to be more focused and in line with the new style.

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

Issue number: closes #2379

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 review from a team as code owners August 13, 2024 09:35
@boring-cyborg boring-cyborg bot added idempotency This item relates to the Idempotency Utility internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) labels Aug 13, 2024
@pull-request-size pull-request-size bot added the size/M PR between 30-99 LOC label Aug 13, 2024
@am29d am29d marked this pull request as draft August 13, 2024 10:35
dreamorosi
dreamorosi requested changes Aug 13, 2024
View reviewed changes
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.

Thanks for working on this - left some minor comments, mainly to resolve outstanding typedoc warnings

packages/idempotency/typedoc.json Outdated Show resolved Hide resolved
packages/idempotency/README.md Outdated Show resolved Hide resolved
packages/idempotency/src/types/IdempotencyOptions.ts Outdated Show resolved Hide resolved
packages/idempotency/src/IdempotencyConfig.ts Outdated Show resolved Hide resolved
@dreamorosi
Copy link
Contributor

Since we have fixed the README.md, we can now remove it from the markdownlint ignores:

  • powertools-lambda-typescript/package.json

    Line 36 in d208b2c

    "lint:markdown": "markdownlint-cli2 '**/*.md' '#node_modules' '#**/*/node_modules' '#docs/changelog.md' '#LICENSE.md' '#.github' '#**/*/CHANGELOG.md' '#examples/app/README.md' '#packages/commons/README.md' '#packages/idempotency/README.md' '#packages/jmespath/README.md' '#packages/logger/README.md' '#packages/metrics/README.md' '#packages/parameters/README.md' '#packages/parser/README.md' '#packages/tracer/README.md'"

  • powertools-lambda-typescript/.markdownlintignore

    Line 16 in d208b2c

    packages/idempotency/README.md

@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Aug 13, 2024
@pull-request-size pull-request-size bot added size/XL PRs between 500-999 LOC, often PRs that grown with feedback and removed size/M PR between 30-99 LOC labels Aug 13, 2024
@am29d am29d marked this pull request as ready for review August 13, 2024 11:36
@boring-cyborg boring-cyborg bot added the dependencies Changes that touch dependencies, e.g. Dependabot, etc. label Aug 13, 2024
@pull-request-size pull-request-size bot added size/L PRs between 100-499 LOC and removed size/XL PRs between 500-999 LOC, often PRs that grown with feedback labels Aug 13, 2024
@am29d am29d requested a review from dreamorosi August 13, 2024 13:16
dreamorosi
dreamorosi approved these changes Aug 13, 2024
View reviewed changes
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.

Thanks for working on this!

@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@dreamorosi dreamorosi merged commit f85cdd1 into main Aug 13, 2024
9 checks passed
@dreamorosi dreamorosi deleted the 2381/idempotency-readme-api-docs branch August 13, 2024 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dreamorosi dreamorosi dreamorosi approved these changes

Assignees

@am29d am29d

Labels
dependencies Changes that touch dependencies, e.g. Dependabot, etc. documentation Improvements or additions to documentation idempotency This item relates to the Idempotency Utility internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/L PRs between 100-499 LOC
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Maintenance: review API docs & README for Idempotency
2 participants
@am29d @dreamorosi