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

docs: add more JSDoc #48712

Merged
merged 2 commits into from
Apr 30, 2024
Merged

docs: add more JSDoc #48712

merged 2 commits into from
Apr 30, 2024

Conversation

leoyongyuan
Copy link
Contributor

中文版模板 / Chinese template

🤔 This is a ...

  • New feature
  • Bug fix
  • Site / documentation update
  • Demo update
  • Component style update
  • TypeScript definition update
  • Bundle size optimization
  • Performance optimization
  • Enhancement feature
  • Internationalization
  • Refactoring
  • Code style optimization
  • Test Case
  • Branch merge
  • Workflow
  • Other (about what?)

🔗 Related issue link

💡 Background and solution

📝 Changelog

Language Changelog
🇺🇸 English docs: add more JSDoc
🇨🇳 Chinese docs: add more JSDoc

☑️ Self-Check before Merge

⚠️ Please check all items below before requesting a reviewing. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • TypeScript definition is updated/provided or not needed
  • Changelog is provided or not needed

Copy link

stackblitz bot commented Apr 30, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link
Contributor

github-actions bot commented Apr 30, 2024

👁 Visual Regression Report for PR #48712 Passed ✅

🎯 Target branch: master (6c7f161)
📖 View Full Report ↗︎

🎊 Congrats! No visual-regression diff found.

Copy link
Contributor

github-actions bot commented Apr 30, 2024

Preview is ready

Copy link

codesandbox-ci bot commented Apr 30, 2024

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

@Wxh16144
Copy link
Member

src/_utils/ 是内部文件,并不对外公开,因此我认为它可能不需要 jsdoc 注释,另外@descCN 标签不属于 JSDoc 范畴。

antd 的 token 有 @descCN 属于给文档用的自定义标签。

考虑到上述原因, 个人感觉这个 PR 的改动不是很重要。

Copy link

codecov bot commented Apr 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (244ad74) to head (a4aab6b).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master    #48712   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          745       745           
  Lines        12947     12947           
  Branches      3383      3383           
=========================================
  Hits         12947     12947           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@afc163
Copy link
Member

afc163 commented Apr 30, 2024

不应该依赖 util 里的方法,不推荐加注释。要加也应该加 @pravite@internal

@leoyongyuan
Copy link
Contributor Author

好的,我不太了解项目的内容,对 JSDoc 也不是很了解,提交了不规范的 PR 很抱歉。
我想先提交一些 JSDoc 来熟悉项目,顺便了解 CI/CD 的流程。我刚刚意识到改动不太准确,我增加了一个新的对外 api 的注释,希望能 review 一下

@afc163 afc163 merged commit 7d27bed into ant-design:master Apr 30, 2024
61 checks passed
Copy link
Contributor

🎉 Thank you for your contribution! If you have not yet joined our DingTalk community group, please feel free to join us (when joining, please provide the link to this PR).

🎉 感谢您的贡献!如果您还没有加入钉钉社区群,请扫描下方二维码加入我们(加群时请提供此 PR 链接)。

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.

None yet

3 participants