Top level docs are mis-placed or missing in most files
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
调研方向
首先检查仓库中的顶层注释和区域标签，尤其是 storage/transfer_service 下的内容，并对照链接的代码片段样式指南。找出缺少注释或在区域标签内包含注释的文件，然后更新受影响的示例，使描述性注释位于这些标签之外，并且不再渲染到生成的文档中。
由索引模型根据 Issue 内容生成。
描述
Per go/code-snippets-style#descriptive-top-level-comment, we should have top level comments that are placed outside of the region tags, to describe the snippets.
From a brief walk through some parts of the repo, I'm noticing most files don't have the top level comment at all, and I also a noticed a number of them, particularly in storage/transfer_service where they are wrongly placed inside the bounds of the region tag, causing them to render in the c.g.c docs, which doesn't seem is the desirable functionality.
- 主要语言
- Jupyter Notebook
- 星标
- 8.1k
- 派生
- 6.7k
- 平均合并
- 4 天 4 小时
- 30 天内合并 PR
- 8
环境准备
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
GoogleCloudPlatform/python-docs-samples 的其他 Issue
-
samples
难度 2/5 1-3 小时 新手友好度 88/100
GoogleCloudPlatform/python-docs-samples#14609 ·
维护者通常 1 天内回复
-
samples
难度 1/5 1 小时以内 新手友好度 92/100
GoogleCloudPlatform/python-docs-samples#14610 ·
维护者通常 1 天内回复
-
samples
难度 2/5 1-3 小时 新手友好度 88/100
GoogleCloudPlatform/python-docs-samples#14611 ·
维护者通常 1 天内回复
-
chore(generative_ai) Update model references for generative_ai samples可能重新可做 @XrossFox 于 152 天前认领，目前没有进行中的 PR。 未关闭samples
GoogleCloudPlatform/python-docs-samples#14117 · 已指派 1 人 ·
维护者通常 1 天内回复
-
Fix Pipeline dependency issues for geospatial-classification/serving_app可能重新可做 @XrossFox 于 163 天前认领，目前没有进行中的 PR。 未关闭samples
GoogleCloudPlatform/python-docs-samples#14091 · 已指派 1 人 ·
维护者通常 1 天内回复
查看 GoogleCloudPlatform/python-docs-samples 的全部 Issue
相似的 Issue
-
automated issue report
难度 2/5 1-3 小时 新手友好度 76/100
-
[Feature]: Remove Kanboard Discourse forum link from README.md and CONTRIBUTING.md, or moderate it未关闭
难度 2/5 1-3 小时 新手友好度 68/100
-
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
docs
难度 1/5 1 小时以内 新手友好度 68/100
remix-run/react-router#15558 ·
维护者通常 1 天内回复
-
难度 1/5 1-3 小时 新手友好度 88/100
supabase/agent-skills#607 ·