From 25a2568ea0240b08579f0520ea4bffd42fedb6d2 Mon Sep 17 00:00:00 2001 From: rzmk <30333942+rzmk@users.noreply.github.com> Date: Thu, 20 Jun 2024 16:49:20 -0400 Subject: [PATCH] docs: show types in Python examples --- README.md | 6 +++--- czv-python/czv.pyi | 11 ++++++++--- czv-python/examples/simple_row_count.py | 4 ++-- 3 files changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 409e8bc..fc9001c 100644 --- a/README.md +++ b/README.md @@ -72,14 +72,14 @@ Or use [`uv pip`](https://github.com/astral-sh/uv) instead of `pip`. ```python import czv -data = """fruits,price +data: str = """fruits,price apple,2.50 banana,3.00 strawberry,1.50""" -output = czv.row_count(file_data=data, include_header_row=True) +output: int = czv.row_count(file_data=data, include_header_row=True) -print(output) +print(output) # 4 ``` ## Available operations diff --git a/czv-python/czv.pyi b/czv-python/czv.pyi index a946695..c38ec29 100644 --- a/czv-python/czv.pyi +++ b/czv-python/czv.pyi @@ -12,11 +12,16 @@ pip install czv ## Example ```python -from czv import row_count +import czv -output = row_count(file_path="fruits.csv") +data: str = \"""fruits,price +apple,2.50 +banana,3.00 +strawberry,1.50\""" -print(output) +output: int = czv.row_count(file_data=data, include_header_row=True) + +print(output) # 4 ``` ## Links diff --git a/czv-python/examples/simple_row_count.py b/czv-python/examples/simple_row_count.py index 623edde..126d061 100644 --- a/czv-python/examples/simple_row_count.py +++ b/czv-python/examples/simple_row_count.py @@ -1,10 +1,10 @@ import czv -data = """fruits,price +data: str = """fruits,price apple,2.50 banana,3.00 strawberry,1.50""" -output = czv.row_count(file_data=data, include_header_row=True) +output: int = czv.row_count(file_data=data, include_header_row=True) print(output) # 4