search

onflow / flow-go

A fast, secure, and developer-friendly blockchain built to support the next generation of games, apps, and the digital assets that power them.
GNU Affero General Public License v3.0
534 stars 179 forks source link

[Documentation] Replaced `type` with [type] #6738

Open durkmurder opened 6 days ago

durkmurder commented 6 days ago

Context

Based on comment on recent PR this PR replaces usages of `type` with [type].

I have used following regex to find all type usages: `([a-zA-Z]+.[a-zA-Z]+)` and then next expression to replace: [$1]

codecov-commenter commented 6 days ago

Codecov Report

Attention: Patch coverage is 84.21053% with 6 lines in your changes missing coverage. Please review.

Project coverage is 41.72%. Comparing base (d0c9695) to head (f7fbe57).

Files with missing lines Patch % Lines
consensus/hotstuff/validator/validator.go 57.14% 3 Missing :warning:
engine/consensus/dkg/reactor_engine.go 0.00% 1 Missing :warning:
module/dkg/client.go 0.00% 1 Missing :warning:
network/validator/pubsub/topic_validator.go 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## feature/efm-recovery #6738 +/- ## ======================================================== + Coverage 41.70% 41.72% +0.01% ======================================================== Files 2030 2030 Lines 180462 180462 ======================================================== + Hits 75261 75295 +34 + Misses 99003 98976 -27 + Partials 6198 6191 -7 ``` | [Flag](https://app.codecov.io/gh/onflow/flow-go/pull/6738/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=onflow) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/onflow/flow-go/pull/6738/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=onflow) | `41.72% <84.21%> (+0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=onflow#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

🚨 Try these New Features:

durkmurder commented 6 days ago

@jordanschalm @turbolent It took me 5 mins to build a regex and replace everything. Pretty much low effort if you ask me. Even if it's not 100% accurate it shouldn't harm replacing all `` with []. As long as tests are passing I am pretty confident that it shouldn't cause a regression.

turbolent commented 6 days ago

Oh yeah, I think replacing linking all occurrences in docstrings if fine, even if they might not work, as long as we don't change non-docstring code 👍