-
-
Notifications
You must be signed in to change notification settings - Fork 315
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
doc(MindMap): add how to use section #5018
Conversation
Reviewer's Guide by SourceryThis PR adds a "How to use" section to the MindMap documentation and refactors some sample code. Class diagram for MindMap component changesclassDiagram
class MindMaps {
-MindMap MindMap
+ExportImage() Task
+ExportJson() Task
+GetFullData() Task
+GetData() Task
+SetData() Task
+Scale(float step) Task
+SetSample1() Task
+SetSample2() Task
}
note for MindMaps "Removed _data field and ExportPng method
Renamed Sample1/2 to SetSample1/2"
File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @ArgoZhang - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5018 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 631 631
Lines 27946 27946
Branches 4003 4003
=========================================
Hits 27946 27946 ☔ View full report in Codecov by Sentry. |
add how to use section
Summary of the changes (Less than 80 chars)
简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号
Description
fixes #5017
Regression?
[If yes, specify the version the behavior has regressed from]
[是否影响老版本]
Risk
[Justify the selection above]
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Add usage instructions to the MindMap component documentation.
Enhancements:
Documentation:
Data
parameter to render the mind map.