Skip to content

[216_50] 修改gf doc和source的提示文档#657

Merged
da-liii merged 3 commits intomainfrom
hxh/216_50/doc
Apr 3, 2026
Merged

[216_50] 修改gf doc和source的提示文档#657
da-liii merged 3 commits intomainfrom
hxh/216_50/doc

Conversation

@wumoin
Copy link
Copy Markdown
Contributor

@wumoin wumoin commented Apr 3, 2026

No description provided.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 3, 2026

Greptile Summary

此 PR 将 gf helpsourcedoc 系列命令的单行提示扩展为多行说明并附带使用示例,同时补充了之前缺失的 doc ORG/LIB FUNC 条目(该功能已在 golddoc-cli.scmlibrary-function 分支中实现)。所有新描述均与实际实现一致,为仅涉及帮助文字的文档性改动。

Confidence Score: 5/5

Safe to merge; changes are help-text only and all new descriptions are accurate.

No logic changes, only display_help() string literals and a new dev-doc file. All remaining findings are P2 style issues (missing template section and trailing blank lines) that do not affect correctness.

devel/216_50.md is missing the "任务相关的代码文件" section per the project template.

Important Files Changed

Filename Overview
src/goldfish.hpp Expands help text for source, doc ORG/LIB, doc ORG/LIB FUNC, doc FUNC, and doc --build-json with multi-line descriptions and usage examples; the new doc ORG/LIB FUNC entry is backed by the existing library-function dispatch path in golddoc-cli.scm.
devel/216_50.md New dev-doc for task 216_50; missing the "任务相关的代码文件" section required by the CLAUDE.md template, and has two extra trailing blank lines.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["gf doc <args>"] --> B["parse-doc-args(argv)"]
    B --> C{parsed type}
    C -->|build-json| D["build-function-indexes!()"]
    C -->|library| E["library-doc-path(query)"]
    C -->|library-function| F["function-doc-path(lib, func)"]
    C -->|function| G["visible-libraries-for-function(func)"]
    C -->|invalid| H["display-usage()"]
    E -->|found| I["display doc file"]
    E -->|not found| J["suggest-visible-functions()"]
    F -->|found| K["display doc file"]
    F -->|not found| L["suggest-library-functions()"]
    G -->|single match| M["display doc file"]
    G -->|multiple matches| N["display-library-choices()"]
    G -->|no match| O["display-function-suggestions()"]
Loading

Reviews (1): Last reviewed commit: "wip" | Re-trigger Greptile

@@ -0,0 +1,27 @@
# [216_50] 修改gf doc和source的提示文档
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 缺少"任务相关的代码文件"章节

CLAUDE.md 中的 devel/x_y.md 模板要求在"如何测试"之前包含一个"任务相关的代码文件"小节,列出修改的实现文件和测试文件。此处缺少该章节,建议补充:

Suggested change
# [216_50] 修改gf doc和source的提示文档
# [216_50] 修改gf doc和source的提示文档
## 任务相关的代码文件
- `src/goldfish.hpp`

Context Used: CLAUDE.md (source)

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Comment on lines +24 to +27



## 2026/04/03 修改gf doc和source的提示文档
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 多余的空行

文件末尾有两个多余的空白行(第 25–26 行),建议删除以保持文档简洁。

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Copy link
Copy Markdown
Contributor

@da-liii da-liii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@da-liii da-liii merged commit 6958308 into main Apr 3, 2026
4 checks passed
@da-liii da-liii deleted the hxh/216_50/doc branch April 3, 2026 05:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants