Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add docstring to main #186

Merged
merged 6 commits into from
Nov 9, 2023
Merged

add docstring to main #186

merged 6 commits into from
Nov 9, 2023

Conversation

LOGIC-10
Copy link
Contributor

@LOGIC-10 LOGIC-10 commented Nov 9, 2023

🤔 What is the nature of this change? / 这个变动的性质是?

  • New feature / 新特性提交
  • Fix bug / bug 修复
  • Refactor code or style / 重构代码或样式
  • Performance optimization / 性能优化
  • Build optimization / 构建优化
  • Website, documentation, demo improvements / 网站、文档、Demo 改进
  • Test related / 测试相关
  • Other / 其他

(The specific problem solved. / 解决的具体问题。)
根据Google规范给每一个.py文件创建了docstring。

📝 Changelog / 更新日志

(Describe changes from the user side, and list all potential break changes or other risks. / 从用户角度描述具体变化,以及可能的 breaking change 和其他风险。)

用户无需解读整个代码即可知道每个类和函数的作用及其参数、返回值等。
可能的风险:改动覆盖范围大
But已经在codespace运行验证,一切正常

截图:

command line 运行截图:
image
GUI运行截图:
image
GUI运行时服务端输出:
9788be29-480b-4488-a81f-695cb641d236
GUI运行结果:
image

Let's Move fast and Break things ❕

@Umpire2018 Umpire2018 merged commit f2eeaef into OpenBMB:main Nov 9, 2023
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