Skip to content

Commit f855a4f

Browse files
leandrodamascenasinofseven
authored andcommitted
docs(api): migrating the parser utility to mkdocstrings (aws-powertools#6004)
* Mkdocstrings - Parser module * Mkdocstrings - Parser module
1 parent bf4c978 commit f855a4f

File tree

3 files changed

+10
-0
lines changed

3 files changed

+10
-0
lines changed

aws_lambda_powertools/utilities/parser/parser.py

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
"""
2+
The Parser utility simplifies data parsing and validation using Pydantic. It allows you to define data models
3+
in pure Python classes, parse and validate incoming events, and extract only the data you need.
4+
!!! abstract "Usage Documentation"
5+
[`Parser`](../utilities/parser.md)
6+
"""
7+
18
from __future__ import annotations
29

310
import logging

docs/api_doc/parser.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<!-- markdownlint-disable MD043 MD041 -->
2+
::: aws_lambda_powertools.utilities.parser.parser

mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ nav:
6363
# - Casual to regular contributor: contributing/tracks/casual_regular_contributor.md
6464
# - Customer to advocate: contributing/tracks/customer_advocate.md
6565
- API Documentation:
66+
- Parser: api_doc/parser.md
6667
- Streaming: api_doc/streaming.md
6768
- Typing: api_doc/typing.md
6869
- Validation: api_doc/validation.md

0 commit comments

Comments
 (0)