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.

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

docs(batch_processing): snippets split, improved, and lint #2231

Merged
merged 17 commits into from
May 11, 2023

Conversation

rubenfonseca
Copy link
Contributor

Issue number: #1369

Summary

Changes

Please provide a summary of what's being changed

This PR extracts, fixes and refactors all code snippets for the batch utility.

User experience

Please share what the user experience looks like before and after this change

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

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.

@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label May 9, 2023
@pull-request-size pull-request-size bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label May 9, 2023
@rubenfonseca rubenfonseca linked an issue May 9, 2023 that may be closed by this pull request
@github-actions github-actions bot added the internal Maintenance changes label May 9, 2023
@github-actions
Copy link
Contributor

github-actions bot commented May 9, 2023

⚠️Large PR detected⚠️

Please consider breaking into smaller PRs to avoid significant review delays. Ignore if this PR has naturally grown to this size after reviews.

1 similar comment
@github-actions
Copy link
Contributor

github-actions bot commented May 9, 2023

⚠️Large PR detected⚠️

Please consider breaking into smaller PRs to avoid significant review delays. Ignore if this PR has naturally grown to this size after reviews.

@rubenfonseca rubenfonseca marked this pull request as ready for review May 9, 2023 13:24
@rubenfonseca rubenfonseca requested a review from a team as a code owner May 9, 2023 13:24
@rubenfonseca rubenfonseca requested review from leandrodamascena and removed request for a team May 9, 2023 13:24
@leandrodamascena
Copy link
Contributor

Hey @rubenfonseca! I'm starting the initial review and should have it wrapped up in the next 1-2 days.

Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

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

Hi @rubenfonseca! This is an incredible amount of work! I made some suggestions on things I found out.

btw, I pushed 2 commits with changes to correct things that I detected in the batch.md file.

@rubenfonseca rubenfonseca changed the title chore(docs): refactor batch processing code snippets docs(batch): refactor batch processing code snippets May 10, 2023
@rubenfonseca
Copy link
Contributor Author

@leandrodamascena ready for round 2

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh mypy!!! WHY?? 😢

I'll move this to the parent folder.

poetry run mypy --pretty aws_lambda_powertools examples
examples/parameters/tests/src/__init__.py: error: Duplicate module named "src" (also at "examples/batch_processing/testing/src/__init__.py")
examples/parameters/tests/src/__init__.py: note: See https://mypy.readthedocs.io/en/stable/running_mypy.html#mapping-file-paths-to-modules for more info
examples/parameters/tests/src/__init__.py: note: Common resolutions include: a) using `--exclude` to avoid checking one of them, b) adding `__init__.py` somewhere, c) using `--explicit-package-bases` or adjusting MYPYPATH
Found 1 error in 1 file (errors prevented further checking)

@codecov-commenter
Copy link

codecov-commenter commented May 10, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (d1e11b7) 97.46% compared to head (cbb6064) 97.46%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2231   +/-   ##
========================================
  Coverage    97.46%   97.46%           
========================================
  Files          149      149           
  Lines         6895     6895           
  Branches       506      506           
========================================
  Hits          6720     6720           
  Misses         137      137           
  Partials        38       38           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

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

Hi @rubenfonseca! Since you are at the Summit this week and I don't want to bother you with minor changes, I pushed 1 commit with some changes.

Please check if it makes sense, if it does, for me this PR is approved!! One more GREAT job man!

docs/utilities/batch.md Outdated Show resolved Hide resolved
docs/utilities/batch.md Outdated Show resolved Hide resolved
docs/utilities/batch.md Outdated Show resolved Hide resolved
docs/utilities/batch.md Outdated Show resolved Hide resolved
@rubenfonseca
Copy link
Contributor Author

@leandrodamascena changes look good! I've made a quick fix to one of the highlights, and for me it's good to merge :)

Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

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

APPROVED!!!
image

@leandrodamascena leandrodamascena changed the title docs(batch): refactor batch processing code snippets docs(batch_processing): snippets split, improved, and lint May 11, 2023
@leandrodamascena leandrodamascena merged commit 89df51e into develop May 11, 2023
@leandrodamascena leandrodamascena deleted the rf/refactor-batch branch May 11, 2023 11:21
heitorlessa added a commit to heitorlessa/aws-lambda-powertools-python that referenced this pull request May 12, 2023
* develop:
  chore(ci): bump package version after release via pull request (aws-powertools#2239)
  chore(ci): convert create-pr steps into composite action (aws-powertools#2238)
  chore(ci): changelog rebuild (aws-powertools#2241)
  chore(deps-dev): bump aws-cdk from 2.78.0 to 2.79.0 (aws-powertools#2235)
  docs(batch_processing): snippets split, improved, and lint (aws-powertools#2231)
  chore(deps-dev): bump mypy from 1.2.0 to 1.3.0 (aws-powertools#2233)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal Maintenance changes size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor Batch Processing docs code snippets
3 participants