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

Fix pydantic-settings to underscore in docs #7288

Merged
merged 1 commit into from Aug 30, 2023

Conversation

FacerAin
Copy link
Contributor

@FacerAin FacerAin commented Aug 30, 2023

Change Summary

In this migration docs, it seems desirable to change "pydantic-settings" to "pydantic_settings" with underscores.
Even though the package repo name is "pydantic-settings", In Python, we still need to use underscores as shown below.

from pydantic_settings import BaseSettings

I believe this change will be helpful for users.

Thanks! ☺️

Related issue number

Checklist

  • The pull request title is a good summary of the changes - it will be used in the changelog
  • Unit tests for the changes exist
  • 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: @adriangb

@FacerAin
Copy link
Contributor Author

please review

@hramezani
Copy link
Member

Thanks @FacerAin

@hramezani hramezani merged commit b9d2a98 into pydantic:main Aug 30, 2023
49 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.

None yet

4 participants