ishangsf/workflows
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: improve docstring workflow guide.

Browse Source
This commit is contained in:
Rankin Zheng 2024-04-02 09:36:06 +08:00
parent 4938eeb74c
commit b66cfc9a4f
1 changed files with 8 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docstring/README.md
View File

@ -1,18 +1,11 @@
需要输入参数，使用指南如下：
### 操作指南
## 1.选中代码
生成函数注释，请按照如下步骤操作：
1. 选中函数代码。
2. 输入\/docstring，回车发送；或点击函数头部**docstring**按钮。
3. 开始生成函数注释，等待生成结束。
4. 自动弹出Diff View，选择是否接受修改。
选中你需要注释的函数，点击函数头部的"docstring"按钮，向 AI 助手发起求。或者在 DevChat 聊天窗口，键入/docstring 直接发起文档注释工作流。
![图片](https://deploy-script.merico.cn/devchat/workflow/docstring_1.png)
![图片](https://deploy-script.merico.cn/devchat/workflow/docstring_2.png)
## 2.生成文档
等待结果，而后进行差异比对。
![图片](https://deploy-script.merico.cn/devchat/workflow/docstring_3.gif)
## 3.比对差异
生成结束后，工作流会自动调用差异比对界面。你可以看到注释代码的差异，接受他们或者逐行比对。
![图片](https://deploy-script.merico.cn/devchat/workflow/docstring_4.png)
如图所示：
![图片](https://deploy-script.merico.cn/devchat/workflow/readme_docstring.gif)