testcontainers / testcontainers/testcontainers-python

Improve DockerCompose documentation

未关闭
#165 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

🐣 good first issue 📖 documentation 🛟 help wanted
主要语言
Python
星标
2.3k
派生
386
平均合并
4 小时 40 分钟
30 天内合并 PR
1

描述

Hi. I'm starting to use testcontainers to test the behavior of a simple P2P network written in Python. I noticed that the auto-generated documentation for each class is just a copy of the constructor (without parameters descriptions) and a small code example. It would be really helpful if, at least, a small description of the behavior of each available method for each class was provided. Then this could be improved by adding a small description of the meaning of each parameter.

Small addition: for some reason, the documentation has really big margins on the left and the right but the title is too long.
Screenshot (113)

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 issue 中链接的生成文档开始,找到 DockerCompose 类及其方法页面。在记录方法行为和参数含义之前,先检查文档的生成和样式设置方式;当页面解释了可用的方法和参数,并且过大的边距和过长的标题得到修正时,即视为完成。

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

评估

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

把新 issue 发到你的邮箱

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