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

[Doc-Gen Tool] Group declarations based on their kind #984

Merged
merged 1 commit into from
Jun 8, 2021

Conversation

SupunS
Copy link
Member

@SupunS SupunS commented Jun 7, 2021

Description

Re-organize the generated documentation such that similar kinds of declarations are grouped together.


  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work
  • Code follows the standards mentioned here
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

@SupunS SupunS self-assigned this Jun 7, 2021
@SupunS SupunS marked this pull request as ready for review June 7, 2021 10:44
@SupunS SupunS requested a review from turbolent as a code owner June 7, 2021 10:44
@SupunS SupunS added Documentation Improvements or additions to documentation Improvement labels Jun 7, 2021
@codecov-commenter
Copy link

Codecov Report

Merging #984 (644e398) into master (91c9cdb) will increase coverage by 0.03%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #984      +/-   ##
==========================================
+ Coverage   75.43%   75.46%   +0.03%     
==========================================
  Files         268      268              
  Lines       32829    32870      +41     
==========================================
+ Hits        24764    24805      +41     
  Misses       6929     6929              
  Partials     1136     1136              
Flag Coverage Δ
unittests 75.46% <ø> (+0.03%) ⬆️

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

Impacted Files Coverage Δ
runtime/interpreter/function.go 56.00% <0.00%> (-1.45%) ⬇️
runtime/interpreter/deployed_contract.go 32.00% <0.00%> (-1.34%) ⬇️
runtime/interpreter/value.go 77.44% <0.00%> (+0.17%) ⬆️
runtime/interpreter/block.go 74.19% <0.00%> (+0.86%) ⬆️
runtime/interpreter/errors.go 26.59% <0.00%> (+5.31%) ⬆️

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 91c9cdb...644e398. Read the comment docs.

Copy link
Member

@turbolent turbolent left a comment

Choose a reason for hiding this comment

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

Nice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation Improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants