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

Update Protocol Kit reference #330

Merged
merged 3 commits into from
Feb 1, 2024
Merged

Update Protocol Kit reference #330

merged 3 commits into from
Feb 1, 2024

Conversation

germartinez
Copy link
Member

Context

This PR:

  • Splits the Protocol Reference into two files (Safe and Safe Factory)
  • Categorizes the methods into sections based on the topic

Copy link

github-actions bot commented Feb 1, 2024

Overall readability score: 66.79 (🔴 -2.01)

File Readability
reference.md 78.13 (🟢 +6.35)
safe-factory.md 56.75 (-)
safe.md 69.63 (-)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
reference.md 78.13 69.48 7.99 7.1 9.14 7.2
  🟢 +6.35 🟢 +19.15 🔴 -0.79 🟢 +3.5 🟢 +3.08 🔴 -1.52
safe-factory.md 56.75 46.78 11.04 11.7 12.12 7.67
  - - - - - -
safe.md 69.63 42.48 7.15 10.6 12.63 5.79
  - - - - - -

Averages:

  Readability FRE GF ARI CLI DCRS
Average 66.79 56.98 9.45 10.1 10.82 7.21
  🔴 -2.01 🔴 -2.06 🔴 -0.28 🔴 -0.27 🔴 -0.22 🔴 -0.15
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

Copy link
Collaborator

@tanay1337 tanay1337 left a comment

Choose a reason for hiding this comment

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

I think there are a few methods and function names that aren't wrapped in backticks.

pages/sdk-protocol-kit/reference/safe-factory.md Outdated Show resolved Hide resolved
pages/sdk-protocol-kit/reference/safe-factory.md Outdated Show resolved Hide resolved
pages/sdk-protocol-kit/reference/safe-factory.md Outdated Show resolved Hide resolved
pages/sdk-protocol-kit/reference/safe-factory.md Outdated Show resolved Hide resolved
pages/sdk-protocol-kit/reference/safe.md Outdated Show resolved Hide resolved
pages/sdk-protocol-kit/reference/safe.md Outdated Show resolved Hide resolved
pages/sdk-protocol-kit/reference/safe.md Outdated Show resolved Hide resolved
pages/sdk-protocol-kit/reference/safe.md Outdated Show resolved Hide resolved
pages/sdk-protocol-kit/reference/safe.md Outdated Show resolved Hide resolved
pages/sdk-protocol-kit/reference/safe.md Outdated Show resolved Hide resolved
@germartinez germartinez requested a review from tanay1337 February 1, 2024 13:41
@germartinez germartinez merged commit 732b159 into main Feb 1, 2024
4 checks passed
@germartinez germartinez deleted the protocol-kit-methods branch February 1, 2024 13:43
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.

3 participants