Skip to content

Conversation

@chbndrhnns
Copy link
Contributor

@chbndrhnns chbndrhnns commented Jul 28, 2023

Change Summary

The installation instructions are incomplete for v1:

  • the pip command installs v2
  • pdm is not mentioned as a dependency
  • the links to the Github repo should be git+https, not git+git

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: @hramezani

@chbndrhnns chbndrhnns force-pushed the fix-docs branch 3 times, most recently from f01260b to 71f9a9d Compare July 28, 2023 13:51
@chbndrhnns
Copy link
Contributor Author

please review

Because of this, setting up and running the tests should be very simple.

You'll need to have a version between **Python 3.7 and 3.11**, **virtualenv**, **git**, and **make** installed.
You'll need to have a version between **Python 3.7 and 3.11**, **virtualenv**, **git**, **pdm** and **make** installed.
Copy link
Member

Choose a reason for hiding this comment

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

I think we don't have pdm in V1

Copy link
Contributor Author

@chbndrhnns chbndrhnns Jul 28, 2023

Choose a reason for hiding this comment

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

make install failed without pdm being installed so I added it. Do you still want me to remove it?

Copy link
Member

Choose a reason for hiding this comment

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

You are right. Sorry!

@hramezani
Copy link
Member

Thanks @chbndrhnns 🙏

Just left a small comment. Other than that LGTM

please update

@pydantic-hooky pydantic-hooky bot added awaiting author revision awaiting changes from the PR author and removed ready for review labels Jul 28, 2023
@pydantic-hooky pydantic-hooky bot assigned chbndrhnns and unassigned hramezani Jul 28, 2023
@hramezani hramezani merged commit 87bf417 into pydantic:1.10.X-fixes Jul 28, 2023
@chbndrhnns chbndrhnns deleted the fix-docs branch July 28, 2023 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting author revision awaiting changes from the PR author

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants