generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 33
Open
Open
Copy link
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedTasks you want help from anyone to move forwardTasks you want help from anyone to move forward
Description
What were you searching in the docs?
The file batch-processing.md contains inline code examples that need to be extracted to separate files.
Is this related to an existing documentation section?
Yes - docs/utilities/batch-processing.md
How can we improve?
Extract inline code examples from batch-processing.md to examples/batch-processing/ folder.
Steps to contribute:
-
Create folder structure: examples/batch-processing/
-
Extract code examples to .cs files using these naming patterns:
GettingStartedBasic.cs- Basic batch processing setupGettingStartedWithSqs.cs- SQS batch processingAdvancedErrorHandling.cs- Error handling examplesCustomSerialization.cs- Custom serialization examplesPartialFailureHandling.cs- Partial failure scenarios
-
Check out this file for complete examples on how to add references to the .md file - https://raw.githubusercontent.com/aws-powertools/powertools-lambda-python/refs/heads/develop/docs/utilities/batch.md
-
Ensure each .cs file:
- Has proper using statements
- Includes complete, runnable code
- Has meaningful class/method names
- Contains inline comments explaining key concepts
Got a suggestion in mind?
Use PascalCase for filenames and descriptive prefixes (GettingStarted, Advanced, Custom)
Acknowledgment
- I understand the final update might be different from my proposed suggestion, or refused.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomershelp wantedTasks you want help from anyone to move forwardTasks you want help from anyone to move forward
Type
Projects
Status
📋 Backlog