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

fix: Update code formatting #612

Merged
merged 4 commits into from
Oct 9, 2024
Merged

fix: Update code formatting #612

merged 4 commits into from
Oct 9, 2024

Conversation

germartinez
Copy link
Member

This PR:

  • Fixes some code formatting

Copy link

github-actions bot commented Oct 3, 2024

Branch preview

✅ Deployed successfully in branch deployment:

https://code_formatting--docs.review.5afe.dev

Copy link

github-actions bot commented Oct 3, 2024

Overall readability score: 38.76 (🟢 +0)

File Readability
permissionless-quickstart.mdx 36.31 (🟢 +0)
delegates.mdx 14.71 (🟢 +0)
safe-operations.mdx 31.37 (🟢 +0)
execute-transactions.mdx 69.23 (🟢 +0)
migrate-to-v4.md 68.79 (🟢 +0)
messages.mdx 75.14 (🟢 +0)
safe.mdx 65.02 (🟢 +0)
migrate-to-v3.md 63.48 (🟢 +0)
dynamic.mdx 51.36 (🟢 +0)
passkeys.mdx 26.69 (🟢 +0)
send-user-operations.mdx 28.33 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
permissionless-quickstart.mdx 36.31 43.77 15.18 18.6 12.89 8.21
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
delegates.mdx 14.71 1.63 14.25 22 19 9.04
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
safe-operations.mdx 31.37 23.22 11.62 18.4 17.22 8.78
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
execute-transactions.mdx 69.23 57.06 9.15 9.8 10.78 6.77
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
migrate-to-v4.md 68.79 57.87 9.66 9 10.32 7.24
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
messages.mdx 75.14 64 8.24 9.8 10.15 6.05
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
safe.mdx 65.02 41.26 7.75 12.2 13.15 5.89
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
migrate-to-v3.md 63.48 48.91 11.33 8.9 9.97 7.74
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
dynamic.mdx 51.36 53.75 13.2 16.1 10.28 7.37
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
passkeys.mdx 26.69 34.94 17.73 22 11.04 8.66
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
send-user-operations.mdx 28.33 35.65 17.52 21.9 11.44 8.17
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 38.76 34.16 12.57 16.56 14.84 8.41
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
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

@tanay1337 tanay1337 self-requested a review October 7, 2024 15:23
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.

@germartinez You'd also have to make the associated changes in the tutorial repos as the code files for them are synced from those repos: https://github.com/safe-global/safe-docs/blob/main/.github/scripts/generateCodeExamples.js

@germartinez
Copy link
Member Author

@tanay1337 good catch!

Done. I formatted the code in the repos for tutorials/demos and run the generateCodeExamples.jsscript in the docs to add the changes in the examples folder.

@germartinez germartinez requested a review from tanay1337 October 9, 2024 12:22
@germartinez germartinez merged commit f68cd6b into main Oct 9, 2024
3 of 4 checks passed
@germartinez germartinez deleted the code-formatting branch October 9, 2024 12:26
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.

2 participants