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

Add examples to jiter-python README #143

Merged
merged 5 commits into from
Sep 23, 2024
Merged

Conversation

simonw
Copy link
Contributor

@simonw simonw commented Sep 22, 2024

I used Claude 3.5 Sonnet to create the first draft of these, then edited them to improve them.

Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

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

1 files reviewed, 1 total issue(s) found.

crates/jiter-python/README.md Outdated Show resolved Hide resolved
@simonw simonw changed the title Add examples to README Add examples to jiter-python README Sep 22, 2024
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Copy link

codspeed-hq bot commented Sep 22, 2024

CodSpeed Performance Report

Merging #143 will not alter performance

Comparing simonw:patch-1 (0387228) with main (ae5fc7d)

Summary

✅ 73 untouched benchmarks

Copy link

codecov bot commented Sep 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@ae5fc7d). Learn more about missing BASE report.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #143   +/-   ##
=======================================
  Coverage        ?   90.94%           
=======================================
  Files           ?       12           
  Lines           ?     2042           
  Branches        ?     2042           
=======================================
  Hits            ?     1857           
  Misses          ?      112           
  Partials        ?       73           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ae5fc7d...06c0ee0. Read the comment docs.

Copy link
Member

@samuelcolvin samuelcolvin left a comment

Choose a reason for hiding this comment

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

Looks good to me, we should also document allow_inf_nan and float_mode, but that could just as well come in a later PR.

crates/jiter-python/README.md Show resolved Hide resolved
crates/jiter-python/README.md Outdated Show resolved Hide resolved
crates/jiter-python/README.md Outdated Show resolved Hide resolved
@samuelcolvin samuelcolvin merged commit 4af2c1c into pydantic:main Sep 23, 2024
26 checks passed
@samuelcolvin
Copy link
Member

thanks so much @simonw, much appreciated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants