Skip to content

Conversation

k4nar
Copy link
Contributor

@k4nar k4nar commented Oct 29, 2024

Change Summary

Improve the documentation of validate_email to indicate what the function returns and which exception it raises.

image

Checklist

  • The pull request title is a good summary of the changes - it will be used in the changelog
  • Tests pass on CI
  • Documentation reflects the changes where applicable
  • My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

Selected Reviewer: @sydney-runkle

Copy link

codspeed-hq bot commented Oct 29, 2024

CodSpeed Performance Report

Merging #10736 will not alter performance

Comparing k4nar:docs/improve-validate_email-doc (7098940) with main (80353c2)

Summary

✅ 44 untouched benchmarks

Copy link
Contributor

Coverage report

This PR does not seem to contain any modification to coverable code.

@k4nar
Copy link
Contributor Author

k4nar commented Oct 29, 2024

please review 🙂

Copy link
Member

@Viicos Viicos left a comment

Choose a reason for hiding this comment

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

Thanks!

@Viicos Viicos merged commit 74f224c into pydantic:main Oct 29, 2024
52 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants