From 4ac2501477a45842c873ed0b5cd42d2aebeb04f1 Mon Sep 17 00:00:00 2001 From: Pax <13646646+paxcodes@users.noreply.github.com> Date: Sat, 4 Sep 2021 10:55:40 -0700 Subject: [PATCH] mention 3.8 requirement in contrib docs (#2856) * mention 3.8 requirement in contrib docs * add change.md for PR#2856 * docs: fix grammar and wording --- changes/2856-paxcodes.md | 1 + docs/contributing.md | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) create mode 100644 changes/2856-paxcodes.md diff --git a/changes/2856-paxcodes.md b/changes/2856-paxcodes.md new file mode 100644 index 0000000..3592ee8 --- /dev/null +++ b/changes/2856-paxcodes.md @@ -0,0 +1 @@ +Update contrib docs re: python version to use for building docs. diff --git a/docs/contributing.md b/docs/contributing.md index b0e0dc5..01c3b44 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -41,9 +41,10 @@ git clone git@github.com:/pydantic.git cd pydantic # 2. Set up a virtualenv for running tests -virtualenv -p `which python3.7` env +virtualenv -p `which python3.8` env source env/bin/activate -# (or however you prefer to setup a python environment, 3.6 will work too) +# Building docs requires 3.8. If you don't need to build docs you can use +# whichever version; 3.6 will work too. # 3. Install pydantic, dependencies, test dependencies and doc dependencies make install