GeezerVison is showing github.com — docs(mkdocs): fix docs warnings (#7211) · dap0am/powertools-lambda-python@6608a9c
File treeExpand file treeCollapse file tree Open diff view settings aws_lambda_powertools/metrics
Expand file treeCollapse file tree Open diff view settings Collapse file Copy file name to clipboardExpand all lines: aws_lambda_powertools/metrics/base.py -5Lines changed: 0 additions & 5 deletions | Original file line number | Diff line number | Diff line change |
|---|
@@ -549,11 +549,6 @@ class SingleMetric(MetricManager): | 549 | 549 | metric.add_dimension(name="function_version", value=47) | 550 | 550 |
| 551 | 551 | print(json.dumps(metric.serialize_metric_set(), indent=4)) | 552 | | -
| 553 | | - Parameters | 554 | | - ---------- | 555 | | - MetricManager : MetricManager | 556 | | - Inherits from `aws_lambda_powertools.metrics.base.MetricManager` | 557 | 552 | """ | 558 | 553 |
| 559 | 554 | def add_metric( | |
Collapse file Copy file name to clipboardExpand all lines: docs/api_doc/metrics/metrics.md -2Lines changed: 0 additions & 2 deletions Collapse file Copy file name to clipboardExpand all lines: docs/build_recipes/getting-started.md +1-1Lines changed: 1 addition & 1 deletion - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -21,7 +21,7 @@ Each build tool has its strengths and is optimized for different use cases. Cons | 21 | 21 | | --------------------- | --------------------------------- | ------------------------------------------- | | 22 | 22 | | **[pip](build-tools.md#pip)** | Simple projects, CI/CD | Lightweight, universal | | 23 | 23 | | **[uv](build-tools.md#uv)** | Fast builds, performance-critical | Extremely fast, Rust-based | | 24 | | -| **[poetry](bbuild-tools.md#poetry)** | Modern Python projects | Excellent dependency management, lock files | | | 24 | +| **[poetry](build-tools.md#poetry)** | Modern Python projects | Excellent dependency management, lock files | | 25 | 25 | | **[SAM](build-tools.md#sam)** | AWS-native deployments | Integrated with AWS, local testing | | 26 | 26 | | **[CDK](build-tools.md#cdk)** | Infrastructure as code | Programmatic infrastructure, type safety | | 27 | 27 | | **[pants](build-tools.md#pants)** | Monorepos, complex projects | Advanced build system, incremental builds | | |
Collapse file Copy file name to clipboardExpand all lines: docs/build_recipes/index.md +1-1Lines changed: 1 addition & 1 deletion - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -39,7 +39,7 @@ This guide is organized into focused sections to help you find exactly what you | 39 | 39 | ### 📚 Fundamentals | 40 | 40 |
| 41 | 41 | * **[Getting started](getting-started.md)** - Prerequisites, tool selection, and basic setup | 42 | | -* **[Cross-platform builds](cross-integration.md)** - Handle architecture differences and compiled dependencies | | 42 | +* **[Cross-platform builds](cross-platform.md)** - Handle architecture differences and compiled dependencies | 43 | 43 |
| 44 | 44 | ### 🔧 Build tools | 45 | 45 |
| |
Collapse file Copy file name to clipboardExpand all lines: docs/contributing/getting_started.md +1-1Lines changed: 1 addition & 1 deletion - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -17,7 +17,7 @@ graph LR | 17 | 17 |
| 18 | 18 | ## Types of contributions | 19 | 19 |
| 20 | | -We consider any contribution that help this project improve everyone's experience to be valid, as long as you agree with our [tenets](../index.md#tenets){target="_blank"}, [licensing](../../LICENSE){target="_blank"}, and [Code of Conduct](#code-of-conduct). | | 20 | +We consider any contribution that help this project improve everyone's experience to be valid, as long as you agree with our [tenets](../index.md#tenets){target="_blank"}, [licensing](https://github.com/aws-powertools/powertools-lambda-python/blob/develop/LICENSE){target="_blank"}, and [Code of Conduct](#code-of-conduct). | 21 | 21 |
| 22 | 22 | Whether you're new contributor or a pro, we compiled a list of the common contributions to help you choose your first: | 23 | 23 |
| |
Collapse file Copy file name to clipboardExpand all lines: docs/core/event_handler/api_gateway.md +1-1Lines changed: 1 addition & 1 deletion - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -1013,7 +1013,7 @@ These are native middlewares that may become native features depending on custom | 1013 | 1013 |
| 1014 | 1014 | | Middleware | Purpose | | 1015 | 1015 | | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | | 1016 | | -| [SchemaValidationMiddleware](/lambda/python/latest/api/event_handler/middlewares/schema_validation.html){target="_blank"} | Validates API request body and response against JSON Schema, using [Validation utility](../../utilities/validation.md){target="_blank"} | | | 1016 | +| SchemaValidationMiddleware | Validates API request body and response against JSON Schema, using [Validation utility](../../utilities/validation.md){target="_blank"} | | 1017 | 1017 |
| 1018 | 1018 | #### Being a good citizen | 1019 | 1019 |
| |
Collapse file Copy file name to clipboardExpand all lines: docs/core/event_handler/bedrock_agents.md +1-1Lines changed: 1 addition & 1 deletion - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -173,7 +173,7 @@ You'll need to regenerate the OpenAPI schema and update your Agent everytime you | 173 | 173 | ``` | 174 | 174 |
| 175 | 175 | 1. This ensures that it's only executed when running the file directly, and not when running on the Lambda runtime. | 176 | | - 2. You can use [additional options](#customizing-openapi-metadata) to customize the OpenAPI schema. | | 176 | + 2. You can use [additional options](#customizing-api-operations) to customize the OpenAPI schema. | 177 | 177 |
| 178 | 178 | === "OpenAPI schema" | 179 | 179 |
| |
Collapse file Copy file name to clipboardExpand all lines: docs/core/metrics.md +1-1Lines changed: 1 addition & 1 deletion - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -395,7 +395,7 @@ Current providers: | 395 | 395 |
| 396 | 396 | | Provider | Notes | | 397 | 397 | | ------------------------------------- | -------------------------------------------------------- | | 398 | | -| [Datadog](./datadog){target="_blank"} | Uses Datadog SDK and Datadog Lambda Extension by default | | | 398 | +| [Datadog](./datadog.md){target="_blank"} | Uses Datadog SDK and Datadog Lambda Extension by default | | 399 | 399 |
| 400 | 400 | ## Testing your code | 401 | 401 |
| |
Collapse file Copy file name to clipboardExpand all lines: docs/tutorial/index.md +2-2Lines changed: 2 additions & 2 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -487,8 +487,8 @@ Let's break this down: | 487 | 487 |
| 488 | 488 | * **L5**: We add Powertools for AWS Lambda (Python) Logger; the boilerplate is now done for you. By default, we set `INFO` as the logging level if `POWERTOOLS_LOG_LEVEL` env var isn't set. | 489 | 489 | * **L22**: We use `logger.inject_lambda_context` decorator to inject key information from Lambda context into every log. | 490 | | -* **L22**: We also instruct Logger to use the incoming API Gateway Request ID as a [correlation id](../core/logger.md##set_correlation_id-method){target="_blank"} automatically. | 491 | | -* **L22**: Since we're in dev, we also use `log_event=True` to automatically log each incoming request for debugging. This can be also set via [environment variables](./index.md#environment-variables){target="_blank"}. | | 490 | +* **L22**: We also instruct Logger to use the incoming API Gateway Request ID as a [correlation id](../core/logger.md#setting-a-correlation-id){target="_blank"} automatically. | | 491 | +* **L22**: Since we're in dev, we also use `log_event=True` to automatically log each incoming request for debugging. This can be also set via [environment variables](../index.md#environment-variables){target="_blank"}. | 492 | 492 |
| 493 | 493 | This is how the logs would look like now: | 494 | 494 |
| |
Collapse file Copy file name to clipboardExpand all lines: docs/upgrade.md +1-1Lines changed: 1 addition & 1 deletion - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -13,7 +13,7 @@ Given our commitment to all of our customers using Powertools for AWS Lambda (Py | 13 | 13 |
| 14 | 14 | ## Migrate to v3 from v2 | 15 | 15 |
| 16 | | -!!! info "We strongly encourage you to migrate to v3. However, if you still need to upgrade from v1 to v2, you can find the [upgrade guide](/lambda/python/2.43.1/upgrade/)." | | 16 | +!!! info "We strongly encourage you to migrate to v3. However, if you still need to upgrade from v1 to v2, you can find the [upgrade guide](https://docs.powertools.aws.dev/lambda/python/2.43.1/)." | 17 | 17 |
| 18 | 18 | We've made minimal breaking changes to make your transition to v3 as smooth as possible. | 19 | 19 |
| |
|