Episode 1.3: PyCharm interpreter text unclear

Open Beginner friendly
#489 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start with the Episode 1.3 PyCharm interpreter section in the lesson source and review its current guidance about autodetection and creating virtual environments. Put the creation instructions in a callout titled "Creating a new virtual environment," make clear that the current project already has one, and preview the lesson to confirm the guidance is consistent.

Written by the indexing model from the issue text.

Description

The PyCharm interpreter section very briefly points out that it's autodetected the virtual environment, then tells users it's best practise to set one up explicitly, and describes how to create a new one. This leads to learners setting up a second one, then being confused about it not having the packages in it that they expect.

It should probably have the whole bit on how to create a new virtual environment in a callout, titled "Creating a new virtual environment", that then repeats in the first sentence that this is unnecessary in your current project as you already have one.

Dominant language
TeX
Stars
63
Forks
78
Avg merge
20h 8m
Merged PRs (30d)
3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from carpentries-incubator/python-intermediate-development

All issues in carpentries-incubator/python-intermediate-development

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.