search

safe-global / safe-docs

Developer Docs for building on Safe.
https://docs.safe.global
MIT License
51 stars 70 forks source link

fix(safe-core-sdk). `init` method docs #611

Open yagopv opened 4 days ago

yagopv commented 4 days ago

Improve init method docs

github-actions[bot] commented 4 days ago

Branch preview

✅ Deployed successfully in branch deployment:

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

github-actions[bot] commented 4 days ago

Overall readability score: 38.76 (🔴 -0.03)

File Readability
safe.mdx 67.2 (🔴 -4.49)
View detailed metrics 🟢 - Shows an _increase_ in readability 🔴 - Shows a _decrease_ in readability File | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- [safe.mdx](https://github.com/safe-global/safe-docs/blob/98caccc2c0d392b87bc2298c4da56c743f0c211e/pages/sdk/protocol-kit/reference/safe.mdx "pages/sdk/protocol-kit/reference/safe.mdx") | 67.2 | 41.46 | 7.56 | 11.5 | 12.69 | 5.84   | 🔴 -4.49 | 🔴 -8.97 | 🔴 -0.27 | 🔴 -1.1 | 🔴 -0.58 | 🔴 -0.04 Averages:   | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- Average | 38.76 | 34.19 | 12.57 | 16.58 | 14.84 | 8.41   | 🔴 -0.03 | 🔴 -0.06 | 🟢 +0 | 🔴 -0.01 | 🟢 +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