twoscoops / twoscoops/Creating-and-Distributing-Python-Packages

Improve explanation for running tests

未关闭
#13 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
没有语言数据
星标
8
派生
0
PR 合并指标
30 天内没有已合并 PR

描述

## Location within the Course

* Section: 4
* Lesson: 1
* Language: English

## Description

In the section "Run the Test Suite With setup.py", I found the instructions a bit confusing. It says: "run the test suite in a temporary testing environment, installing whatever is needed from test_requirements into that environment:". It wasn't immediately obvious to me that we should be in our projects/packaging/ folder, but in a new virtual environment where we `pip install` what is in the `test_requirements` list.

Perhaps a bit more explanation, plus a description of what else might be in the `test_requirements` list, if anything. Or if there are cases where we might want to add things to the list, if that applies at all. Since it's a list, seems like there might be multiple things in it.

Also, in the "Optional: Run the Test Suite Without setup.py", be more explicit that we are installing pytest in our original project package environment rather than a new test environment.

贡献指南

打开贡献指南

调研方向

从第 4 节、第 1 课开始,重点关注“Run the Test Suite With setup.py”和“Optional: Run the Test Suite Without setup.py”。明确工作目录、虚拟环境之间的区别、pytest 的安装方式,以及 test_requirements 的用途和可能包含的内容。完成的标准是读者能够毫无歧义地区分这两种工作流。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。