Skip to content
New issue

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

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

Already on GitHub? # to your account

doc(hansbug): update README #42

Merged
merged 13 commits into from
Jun 23, 2022
Merged

doc(hansbug): update README #42

merged 13 commits into from
Jun 23, 2022

Conversation

HansBug
Copy link
Member

@HansBug HansBug commented Jun 19, 2022

No description provided.

@HansBug HansBug added the documentation Improvements or additions to documentation label Jun 19, 2022
@HansBug HansBug self-assigned this Jun 19, 2022
@codecov
Copy link

codecov bot commented Jun 19, 2022

Codecov Report

Merging #42 (ee2a552) into main (ae999e1) will increase coverage by 0.00%.
The diff coverage is n/a.

❗ Current head ee2a552 differs from pull request most recent head 2a07cfb. Consider uploading reports for the commit 2a07cfb to get more accurate results

@@           Coverage Diff           @@
##             main      #42   +/-   ##
=======================================
  Coverage   99.22%   99.22%           
=======================================
  Files          35       35           
  Lines        2066     2071    +5     
=======================================
+ Hits         2050     2055    +5     
  Misses         16       16           
Flag Coverage Δ
unittests 99.22% <0.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
treevalue/entry/cli/graph.py 100.00% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ae999e1...2a07cfb. Read the comment docs.

@HansBug HansBug requested a review from PaParaZz1 June 20, 2022 04:43
When we build a complex nested structure, we need to model it as a tree structure, and the native list and dict in Python are often used to solve this problem. However, it takes a lot of codes and some complex and non-intuitive calculation logics, which is not easy to modify and extend related code and data, and parallelization is more impossible.

Therefore, we need a kind of more proper data container, named `TreeValue`. It is designed for solving the follow problems:

Copy link
Member

Choose a reason for hiding this comment

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

whether to add our overview layer graph

Copy link
Member Author

Choose a reason for hiding this comment

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

I think it is not necessary, and the graph's is verrrrrry long which may break the view of readme.

May be hushuai can given some suggestions?

@HansBug HansBug added this to the v1.4.0 Release milestone Jun 21, 2022
@HansBug HansBug merged commit bfbd23d into main Jun 23, 2022
@HansBug HansBug deleted the doc/readme branch June 23, 2022 07:19
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants