Create a script that updates proto links in the spec docs and apply it for v1.19.0 #2068
Conversation
…y just has argument parsing and file identification.
…oads them into a temp dir.
…points and their messages also from the protos, and identify all the links and their messages from the markdown files.
…ages to generate an error.
… over output. Make it possible to have the script only do cleanup on success.
… been published, so I was able to click on all the links to verify that they are correct.
…st yet). I verified that the only diffs were the removal of the '-rc2' from all of the links. I.e. file and line numbers stayed the same.
WalkthroughThis update includes new scripts for processing and updating proto file references in spec documentation, ensuring they point to the correct lines and versions ( Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
I checked all of the updated links, and they all point to the correct proto content. I did it by first generating all the links for .scripts/update-spec-links.sh v1.19.0-rc2I then went through the resulting diffs and clicked on all of the new links and verified that it was for the message that the markdown file is talking about. I committed all of those: 9ceb319. I then re-ran the script for .scripts/update-spec-links.sh v1.19.0This time, I just checked all of the diffs to make sure that the only changes were the removal of |
…vided. Tweak some of the comments from proofreading.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 42
Outside diff range and nitpick comments (70)
x/trigger/spec/07_genesis.md (1)
14-14: Replace bare URL with a proper markdown link.Bare URLs should be avoided in markdown files. Replace with a proper markdown link to improve readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/trigger/v1/genesis.proto#L11-L30 + [GenesisState Proto](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/trigger/v1/genesis.proto#L11-L30)Tools
Markdownlint
14-14: null
Bare URL used(MD034, no-bare-urls)
x/oracle/spec/06_genesis.md (1)
18-18: Replace bare URL with a proper markdown link.Bare URLs should be avoided in markdown files. Replace with a proper markdown link to improve readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/oracle/v1/genesis.proto#L10-L19 + [GenesisState Proto](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/oracle/v1/genesis.proto#L10-L19)Tools
Markdownlint
18-18: null
Bare URL used(MD034, no-bare-urls)
x/trigger/spec/04_queries.md (4)
21-21: Replace bare URL with a proper markdown link.Bare URLs should be avoided in markdown files. Replace with a proper markdown link to improve readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/trigger/v1/query.proto#L25-L29 + [QueryTriggerByID Request Proto](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/trigger/v1/query.proto#L25-L29)Tools
Markdownlint
21-21: null
Bare URL used(MD034, no-bare-urls)
27-27: Replace bare URL with a proper markdown link.Bare URLs should be avoided in markdown files. Replace with a proper markdown link to improve readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/trigger/v1/query.proto#L31-L35 + [QueryTriggerByID Response Proto](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/trigger/v1/query.proto#L31-L35)Tools
Markdownlint
27-27: null
Bare URL used(MD034, no-bare-urls)
37-37: Replace bare URL with a proper markdown link.Bare URLs should be avoided in markdown files. Replace with a proper markdown link to improve readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/trigger/v1/query.proto#L37-L41 + [QueryTriggers Request Proto](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/trigger/v1/query.proto#L37-L41)Tools
Markdownlint
37-37: null
Bare URL used(MD034, no-bare-urls)
41-41: Replace bare URL with a proper markdown link.Bare URLs should be avoided in markdown files. Replace with a proper markdown link to improve readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/trigger/v1/query.proto#L43-L49 + [QueryTriggers Response Proto](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/trigger/v1/query.proto#L43-L49)Tools
Markdownlint
41-41: null
Bare URL used(MD034, no-bare-urls)
x/oracle/spec/04_queries.md (4)
19-19: Replace bare URL with a proper markdown link.Bare URLs should be avoided in markdown files. Replace with a proper markdown link to improve readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/oracle/v1/query.proto#L25-L26 + [QueryOracleAddress Request Proto](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/oracle/v1/query.proto#L25-L26)Tools
Markdownlint
19-19: null
Bare URL used(MD034, no-bare-urls)
23-23: Replace bare URL with a proper markdown link.Bare URLs should be avoided in markdown files. Replace with a proper markdown link to improve readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/oracle/v1/query.proto#L28-L32 + [QueryOracleAddress Response Proto](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/oracle/v1/query.proto#L28-L32)Tools
Markdownlint
23-23: null
Bare URL used(MD034, no-bare-urls)
32-32: Replace bare URL with a proper markdown link.Bare URLs should be avoided in markdown files. Replace with a proper markdown link to improve readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/oracle/v1/query.proto#L34-L38 + [QueryOracle Request Proto](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/oracle/v1/query.proto#L34-L38)Tools
Markdownlint
32-32: null
Bare URL used(MD034, no-bare-urls)
36-36: Replace bare URL with a proper markdown link.Bare URLs should be avoided in markdown files. Replace with a proper markdown link to improve readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/oracle/v1/query.proto#L40-L44 + [QueryOracle Response Proto](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/oracle/v1/query.proto#L40-L44)Tools
Markdownlint
36-36: null
Bare URL used(MD034, no-bare-urls)
x/sanction/spec/03_messages.md (3)
15-15: Format the URL as a markdown link.Bare URLs should be formatted as markdown links for better readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/tx.proto#L24-L34 + [MsgSanction](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/tx.proto#L24-L34)Tools
Markdownlint
15-15: null
Bare URL used(MD034, no-bare-urls)
34-34: Format the URL as a markdown link.Bare URLs should be formatted as markdown links for better readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/tx.proto#L39-L49 + [MsgUnsanction](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/tx.proto#L39-L49)Tools
Markdownlint
34-34: null
Bare URL used(MD034, no-bare-urls)
52-52: Format the URL as a markdown link.Bare URLs should be formatted as markdown links for better readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/tx.proto#L54-L64 + [MsgUpdateParams](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/tx.proto#L54-L64)Tools
Markdownlint
52-52: null
Bare URL used(MD034, no-bare-urls)
x/quarantine/spec/05_queries.md (6)
Line range hint
10-10:
Format the URL as a markdown link.Bare URLs should be formatted as markdown links for better readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/query.proto#L44-L48 + [QueryIsQuarantinedRequest](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/query.proto#L44-L48)Tools
Markdownlint
34-34: null
Bare URL used(MD034, no-bare-urls)
39-39: null
Bare URL used(MD034, no-bare-urls)
Line range hint
13-13:
Format the URL as a markdown link.Bare URLs should be formatted as markdown links for better readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/query.proto#L50-L54 + [QueryIsQuarantinedResponse](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/query.proto#L50-L54)Tools
Markdownlint
34-34: null
Bare URL used(MD034, no-bare-urls)
39-39: null
Bare URL used(MD034, no-bare-urls)
Line range hint
22-22:
Format the URL as a markdown link.Bare URLs should be formatted as markdown links for better readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/query.proto#L56-L65 + [QueryQuarantinedFundsRequest](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/query.proto#L56-L65)Tools
Markdownlint
34-34: null
Bare URL used(MD034, no-bare-urls)
39-39: null
Bare URL used(MD034, no-bare-urls)
Line range hint
25-25:
Format the URL as a markdown link.Bare URLs should be formatted as markdown links for better readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/query.proto#L67-L74 + [QueryQuarantinedFundsResponse](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/query.proto#L67-L74)Tools
Markdownlint
34-34: null
Bare URL used(MD034, no-bare-urls)
39-39: null
Bare URL used(MD034, no-bare-urls)
39-39: Format the URL as a markdown link.Bare URLs should be formatted as markdown links for better readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/quarantine.proto#L11-L26 + [QuarantinedFunds](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/quarantine.proto#L11-L26)Tools
Markdownlint
39-39: null
Bare URL used(MD034, no-bare-urls)
68-68: Format the URL as a markdown link.Bare URLs should be formatted as markdown links for better readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/quarantine.proto#L28-L36 + [AutoResponseEntry](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/quarantine.proto#L28-L36)Tools
Markdownlint
68-68: null
Bare URL used(MD034, no-bare-urls)
x/sanction/spec/05_queries.md (6)
Line range hint
10-10:
Format the URL as a markdown link.Bare URLs should be formatted as markdown links for better readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/query.proto#L34-L37 + [QueryIsSanctionedRequest](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/query.proto#L34-L37)Tools
Markdownlint
60-60: null
Bare URL used(MD034, no-bare-urls)
65-65: null
Bare URL used(MD034, no-bare-urls)
70-70: null
Bare URL used(MD034, no-bare-urls)
Line range hint
13-13:
Format the URL as a markdown link.Bare URLs should be formatted as markdown links for better readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/query.proto#L39-L43 + [QueryIsSanctionedResponse](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/query.proto#L39-L43)Tools
Markdownlint
60-60: null
Bare URL used(MD034, no-bare-urls)
65-65: null
Bare URL used(MD034, no-bare-urls)
70-70: null
Bare URL used(MD034, no-bare-urls)
Line range hint
22-22:
Format the URL as a markdown link.Bare URLs should be formatted as markdown links for better readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/query.proto#L45-L49 + [QuerySanctionedAddressesRequest](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/query.proto#L45-L49)Tools
Markdownlint
60-60: null
Bare URL used(MD034, no-bare-urls)
65-65: null
Bare URL used(MD034, no-bare-urls)
70-70: null
Bare URL used(MD034, no-bare-urls)
Line range hint
25-25:
Format the URL as a markdown link.Bare URLs should be formatted as markdown links for better readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/query.proto#L51-L58 + [QuerySanctionedAddressesResponse](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/query.proto#L51-L58)Tools
Markdownlint
60-60: null
Bare URL used(MD034, no-bare-urls)
65-65: null
Bare URL used(MD034, no-bare-urls)
70-70: null
Bare URL used(MD034, no-bare-urls)
65-65: Format the URL as a markdown link.Bare URLs should be formatted as markdown links for better readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/sanction.proto#L36-L44 + [TemporaryEntry](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/sanction.proto#L36-L44)Tools
Markdownlint
65-65: null
Bare URL used(MD034, no-bare-urls)
70-70: Format the URL as a markdown link.Bare URLs should be formatted as markdown links for better readability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/sanction.proto#L46-L56 + [TempStatus](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/sanction/v1beta1/sanction.proto#L46-L56)Tools
Markdownlint
70-70: null
Bare URL used(MD034, no-bare-urls)
x/quarantine/spec/03_messages.md (6)
15-15: Use proper markdown link syntax.Bare URLs should be avoided in markdown. Use proper markdown link syntax to improve readability and maintainability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/tx.proto#L36-L41 + [MsgOptIn](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/tx.proto#L36-L41)Tools
Markdownlint
15-15: null
Bare URL used(MD034, no-bare-urls)
24-24: Use proper markdown link syntax.Bare URLs should be avoided in markdown. Use proper markdown link syntax to improve readability and maintainability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/tx.proto#L46-L51 + [MsgOptOut](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/tx.proto#L46-L51)Tools
Markdownlint
24-24: null
Bare URL used(MD034, no-bare-urls)
34-34: Use proper markdown link syntax.Bare URLs should be avoided in markdown. Use proper markdown link syntax to improve readability and maintainability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/tx.proto#L56-L70 + [MsgAccept](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/tx.proto#L56-L70)Tools
Markdownlint
34-34: null
Bare URL used(MD034, no-bare-urls)
50-50: Use proper markdown link syntax.Bare URLs should be avoided in markdown. Use proper markdown link syntax to improve readability and maintainability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/tx.proto#L72-L81 + [MsgAcceptResponse](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/tx.proto#L72-L81)Tools
Markdownlint
50-50: null
Bare URL used(MD034, no-bare-urls)
58-58: Use proper markdown link syntax.Bare URLs should be avoided in markdown. Use proper markdown link syntax to improve readability and maintainability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/tx.proto#L83-L97 + [MsgDecline](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/tx.proto#L83-L97)Tools
Markdownlint
58-58: null
Bare URL used(MD034, no-bare-urls)
77-77: Use proper markdown link syntax.Bare URLs should be avoided in markdown. Use proper markdown link syntax to improve readability and maintainability.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/tx.proto#L102-L111 + [MsgUpdateAutoResponses](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/cosmos/quarantine/v1beta1/tx.proto#L102-L111)Tools
Markdownlint
77-77: null
Bare URL used(MD034, no-bare-urls)
scripts/identify-messages.awk (1)
1-23: Fix typo in comments.There is a typo in the word "maintenance" in the comments.
- # as its own awk script file to help facilitate troubleshooting and maintenence. + # as its own awk script file to help facilitate troubleshooting and maintenance.x/exchange/spec/02_state.md (1)
223-223: Convert bare URL to markdown link.To comply with markdownlint rules, the bare URL should be converted to a markdown link.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/exchange/v1/market.proto#L14-L26 + [MarketAccount](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/exchange/v1/market.proto#L14-L26)Tools
Markdownlint
223-223: null
Bare URL used(MD034, no-bare-urls)
x/marker/spec/01_state.md (3)
23-23: Convert bare URL to markdown link.To comply with markdownlint rules, the bare URL should be converted to a markdown link.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/marker.proto#L28-L59 + [MarkerAccount](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/marker.proto#L28-L59)Tools
Markdownlint
23-23: null
Bare URL used(MD034, no-bare-urls)
188-188: Convert bare URL to markdown link.To comply with markdownlint rules, the bare URL should be converted to a markdown link.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/marker.proto#L91-L99 + [NetAssetValue](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/marker.proto#L91-L99)Tools
Markdownlint
188-188: null
Bare URL used(MD034, no-bare-urls)
197-197: Convert bare URL to markdown link.To comply with markdownlint rules, the bare URL should be converted to a markdown link.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/marker.proto#L14-L26 + [Params](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/marker.proto#L14-L26)Tools
Markdownlint
197-197: null
Bare URL used(MD034, no-bare-urls)
x/marker/spec/10_governance.md (8)
31-31: Update bare URL to a proper link format.Markdownlint suggests avoiding bare URLs. Use proper markdown link formatting.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L16-L33 + [Add Marker Proposal](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L16-L33)Tools
Markdownlint
31-31: null
Bare URL used(MD034, no-bare-urls)
47-47: Update bare URL to a proper link format.Markdownlint suggests avoiding bare URLs. Use proper markdown link formatting.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L35-L47 + [Supply Increase Proposal](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L35-L47)Tools
Markdownlint
47-47: null
Bare URL used(MD034, no-bare-urls)
58-58: Update bare URL to a proper link format.Markdownlint suggests avoiding bare URLs. Use proper markdown link formatting.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L49-L60 + [Supply Decrease Proposal](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L49-L60)Tools
Markdownlint
58-58: null
Bare URL used(MD034, no-bare-urls)
74-74: Update bare URL to a proper link format.Markdownlint suggests avoiding bare URLs. Use proper markdown link formatting.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L62-L74 + [Set Administrator Proposal](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L62-L74)Tools
Markdownlint
74-74: null
Bare URL used(MD034, no-bare-urls)
87-87: Update bare URL to a proper link format.Markdownlint suggests avoiding bare URLs. Use proper markdown link formatting.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L76-L88 + [Remove Administrator Proposal](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L76-L88)Tools
Markdownlint
87-87: null
Bare URL used(MD034, no-bare-urls)
99-99: Update bare URL to a proper link format.Markdownlint suggests avoiding bare URLs. Use proper markdown link formatting.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L90-L101 + [Change Status Proposal](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L90-L101)Tools
Markdownlint
99-99: null
Bare URL used(MD034, no-bare-urls)
114-114: Update bare URL to a proper link format.Markdownlint suggests avoiding bare URLs. Use proper markdown link formatting.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L103-L120 + [Withdraw Escrow Proposal](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L103-L120)Tools
Markdownlint
114-114: null
Bare URL used(MD034, no-bare-urls)
125-125: Update bare URL to a proper link format.Markdownlint suggests avoiding bare URLs. Use proper markdown link formatting.
- +++ https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L122-L133 + [Set Denom Metadata Proposal](https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/marker/v1/proposals.proto#L122-L133)Tools
Markdownlint
125-125: null
Bare URL used(MD034, no-bare-urls)
scripts/identify-endpoints.awk (4)
1-7: Typographical corrections in comments.Correct typos in the comments for better readability and maintainability.
- # To include debugging information in the output, provide these arguments to the awk command: -v debug='1' + # To include debugging information in the output, provide these arguments to the AWK command: -v debug='1' - # to help facilitate troubleshooting and maintenence. + # to help facilitate troubleshooting and maintenance.
9-9: Typographical correction in comments.Correct typo in the comments for better readability and maintainability.
- # Each line of ouptut will have one of these formats: + # Each line of output will have one of these formats:
58-58: Typographical correction in comments.Correct typo in the comments for better readability and maintainability.
- # The rpc line should now have evertything we need in here. It'll have a format like this: + # The rpc line should now have everything we need in here. It'll have a format like this:
81-81: Typographical correction in comments.Correct typo in the comments for better readability and maintainability.
- # Extract the response name by deleting everything before (and including) the open paran after the word "returns". + # Extract the response name by deleting everything before (and including) the open paren after the word "returns".x/metadata/spec/03_messages.md (22)
51-51: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L93-L119 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L93-L119>Tools
Markdownlint
51-51: null
Bare URL used(MD034, no-bare-urls)
63-63: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L121-L125 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L121-L125>Tools
Markdownlint
63-63: null
Bare URL used(MD034, no-bare-urls)
83-83: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L127-L136 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L127-L136>Tools
Markdownlint
83-83: null
Bare URL used(MD034, no-bare-urls)
87-87: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L138-L139 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L138-L139>Tools
Markdownlint
87-87: null
Bare URL used(MD034, no-bare-urls)
102-102: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L141-L154 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L141-L154>Tools
Markdownlint
102-102: null
Bare URL used(MD034, no-bare-urls)
106-106: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L156-L157 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L156-L157>Tools
Markdownlint
106-106: null
Bare URL used(MD034, no-bare-urls)
122-122: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L159-L172 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L159-L172>Tools
Markdownlint
122-122: null
Bare URL used(MD034, no-bare-urls)
126-126: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L174-L175 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L174-L175>Tools
Markdownlint
126-126: null
Bare URL used(MD034, no-bare-urls)
141-141: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L177-L190 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L177-L190>Tools
Markdownlint
141-141: null
Bare URL used(MD034, no-bare-urls)
145-145: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L192-L193 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L192-L193>Tools
Markdownlint
145-145: null
Bare URL used(MD034, no-bare-urls)
162-162: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L195-L208 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L195-L208>Tools
Markdownlint
162-162: null
Bare URL used(MD034, no-bare-urls)
166-166: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L210-L211 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L210-L211>Tools
Markdownlint
166-166: null
Bare URL used(MD034, no-bare-urls)
182-182: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L213-L225 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L213-L225>Tools
Markdownlint
182-182: null
Bare URL used(MD034, no-bare-urls)
186-186: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L227-L228 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L227-L228>Tools
Markdownlint
186-186: null
Bare URL used(MD034, no-bare-urls)
202-202: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L230-L242 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L230-L242>Tools
Markdownlint
202-202: null
Bare URL used(MD034, no-bare-urls)
206-206: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L244-L245 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L244-L245>Tools
Markdownlint
206-206: null
Bare URL used(MD034, no-bare-urls)
224-224: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L247-L272 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L247-L272>Tools
Markdownlint
224-224: null
Bare URL used(MD034, no-bare-urls)
235-235: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L287-L291 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L287-L291>Tools
Markdownlint
235-235: null
Bare URL used(MD034, no-bare-urls)
262-262: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L293-L323 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L293-L323>Tools
Markdownlint
262-262: null
Bare URL used(MD034, no-bare-urls)
273-273: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L325-L329 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L325-L329>Tools
Markdownlint
273-273: null
Bare URL used(MD034, no-bare-urls)
315-315: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L331-L340 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L331-L340>Tools
Markdownlint
315-315: null
Bare URL used(MD034, no-bare-urls)
319-319: Use angle brackets for URLs.To comply with markdownlint rule MD034, enclose the URL in angle brackets.
- https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L342-L343 + <https://github.com/provenance-io/provenance/blob/v1.19.0/proto/provenance/metadata/v1/tx.proto#L342-L343>Tools
Markdownlint
319-319: null
Bare URL used(MD034, no-bare-urls)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (28)
- CHANGELOG.md (1 hunks)
- scripts/identify-endpoints.awk (1 hunks)
- scripts/identify-links.awk (1 hunks)
- scripts/identify-messages.awk (1 hunks)
- scripts/update-spec-links.sh (1 hunks)
- x/exchange/spec/02_state.md (1 hunks)
- x/exchange/spec/03_messages.md (29 hunks)
- x/exchange/spec/05_queries.md (23 hunks)
- x/exchange/spec/06_params.md (1 hunks)
- x/hold/spec/04_queries.md (2 hunks)
- x/marker/spec/01_state.md (3 hunks)
- x/marker/spec/03_messages.md (21 hunks)
- x/marker/spec/07_events.md (1 hunks)
- x/marker/spec/10_governance.md (8 hunks)
- x/metadata/spec/02_state.md (7 hunks)
- x/metadata/spec/03_messages.md (26 hunks)
- x/metadata/spec/05_queries.md (27 hunks)
- x/oracle/spec/03_messages.md (1 hunks)
- x/oracle/spec/04_queries.md (1 hunks)
- x/oracle/spec/06_genesis.md (1 hunks)
- x/quarantine/spec/03_messages.md (5 hunks)
- x/quarantine/spec/05_queries.md (2 hunks)
- x/sanction/spec/03_messages.md (3 hunks)
- x/sanction/spec/05_queries.md (1 hunks)
- x/trigger/spec/02_state.md (2 hunks)
- x/trigger/spec/03_messages.md (2 hunks)
- x/trigger/spec/04_queries.md (1 hunks)
- x/trigger/spec/07_genesis.md (1 hunks)
Files not reviewed due to server errors (3)
- x/exchange/spec/05_queries.md
- scripts/identify-links.awk
- x/marker/spec/03_messages.md
Files skipped from review due to trivial changes (1)
- x/marker/spec/07_events.md
Additional context used
LanguageTool
x/trigger/spec/07_genesis.md
[typographical] ~7-~7: It appears that a comma is missing.
Context: ...rder: 7 --> # Trigger Genesis In this section we describe the processing of the trigg...(DURING_THAT_TIME_COMMA)
x/oracle/spec/06_genesis.md
[typographical] ~7-~7: It appears that a comma is missing.
Context: ...order: 6 --> # Oracle Genesis In this section we describe the processing of the oracl...(DURING_THAT_TIME_COMMA)
x/trigger/spec/04_queries.md
[typographical] ~7-~7: It appears that a comma is missing.
Context: ...rder: 4 --> # Trigger Queries In this section we describe the queries available for l...(DURING_THAT_TIME_COMMA)
x/oracle/spec/04_queries.md
[typographical] ~7-~7: It appears that a comma is missing.
Context: # Queries In this section we describe the queries available for l...(DURING_THAT_TIME_COMMA)
x/oracle/spec/03_messages.md
[typographical] ~7-~7: It appears that a comma is missing.
Context: # Messages In this section we describe the processing of the oracl...(DURING_THAT_TIME_COMMA)
x/trigger/spec/03_messages.md
[typographical] ~7-~7: It appears that a comma is missing.
Context: # Messages In this section we describe the processing of the trigg...(DURING_THAT_TIME_COMMA)
x/sanction/spec/03_messages.md
[uncategorized] ~18-~18: Possible missing comma found.
Context: ...ire at the completion of the governance proposal regardless of outcome. If the proposal...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~37-~37: Possible missing comma found.
Context: ...ire at the completion of the governance proposal regardless of outcome. If the proposal...(AI_HYDRA_LEO_MISSING_COMMA)
x/trigger/spec/02_state.md
[uncategorized] ~51-~51: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e when a transaction event matching the user defined one has been emitted. +++ https://gith...(EN_COMPOUND_ADJECTIVE_INTERNAL)
x/marker/spec/10_governance.md
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...n directly set a marker to theActivestatus with the appropriate minting operations...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~34-~34: In American English, abbreviations like “etc.” require a period.
Context: ...ce proposal format (title, description, etc) is invalid - The marker request contai...(ETC_PERIOD)
[style] ~50-~50: In American English, abbreviations like “etc.” require a period.
Context: ...ce proposal format (title, description, etc) is invalid - The requested supply exce...(ETC_PERIOD)
[style] ~61-~61: In American English, abbreviations like “etc.” require a period.
Context: ...ce proposal format (title, description, etc) is invalid - Marker does not allow gov...(ETC_PERIOD)
[style] ~77-~77: In American English, abbreviations like “etc.” require a period.
Context: ...ce proposal format (title, description, etc) is invalid - The marker does not exist...(ETC_PERIOD)
[style] ~90-~90: In American English, abbreviations like “etc.” require a period.
Context: ...ce proposal format (title, description, etc) is invalid - The marker does not exist...(ETC_PERIOD)
[style] ~102-~102: In American English, abbreviations like “etc.” require a period.
Context: ...ce proposal format (title, description, etc) is invalid - Marker does not allow gov...(ETC_PERIOD)
[style] ~117-~117: In American English, abbreviations like “etc.” require a period.
Context: ...ce proposal format (title, description, etc) is invalid - Marker does not allow gov...(ETC_PERIOD)
[style] ~128-~128: In American English, abbreviations like “etc.” require a period.
Context: ...ce proposal format (title, description, etc) is invalid - Marker does not allow gov...(ETC_PERIOD)
x/marker/spec/01_state.md
[typographical] ~18-~18: Consider adding a comma after this introductory phrase.
Context: ...e of theauthSDK module. As a valid account a marker is able to perform normal func...(AS_A_NN_COMMA)
[style] ~19-~19: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...DK module. As a valid account a marker is able to perform normal functions such as receiv...(BE_ABLE_TO)
x/metadata/spec/05_queries.md
[misspelling] ~104-~104: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...milarly, thesession_idcan either be a uuid or session address, e.g. `session1...(EN_A_VS_AN)
[misspelling] ~240-~240: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...3 Thespecification_idcan either be a uuid, e.g. `dc83ea70-eacd-40fe-9adf-1cf...(EN_A_VS_AN)
[misspelling] ~271-~271: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...4 Thespecification_idcan either be a uuid, e.g. `def6bc0a-c9dd-4874-948f-520...(EN_A_VS_AN)
[misspelling] ~311-~311: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...2 Thespecification_idcan either be a uuid, e.g. `def6bc0a-c9dd-4874-948f-520...(EN_A_VS_AN)
[misspelling] ~328-~328: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...5 Thespecification_idcan either be a uuid, e.g. `def6bc0a-c9dd-4874-948f-520...(EN_A_VS_AN)
[misspelling] ~376-~376: This word is normally spelled as one.
Context: ... parameters of the Object Store Locator sub-module. ### Request +++ https://github.com/pr...(EN_COMPOUNDS_SUB_MODULE)
x/marker/spec/03_messages.md
[style] ~34-~34: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...ker service message. The created marker can not be directly added in an Active (or Canc...(CAN_NOT_PREMIUM)
[style] ~123-~123: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...signed to serve as an intermediate step prior to activation that indicates marker config...(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~145-~145: Possible missing comma found.
Context: ... modification. If a marker has a fixed supply the begin block/invariant supply checks...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~145-~145: The word ‘begin’ is not a noun. Did you mean “beginning” or “start”?
Context: ...on. If a marker has a fixed supply the begin block/invariant supply checks are also ...(PREPOSITION_VERB)
[style] ~165-~165: This phrasing could be wordy, so try replacing it with something more concise.
Context: ... the marker - The amount in circulation is greater than zero or any remaining amount is not cur...(MORE_THAN_EXCEEDS)
[style] ~205-~205: Consider a shorter alternative to avoid wordiness.
Context: ...y of the marker coin from circulation. In order to successfully burn supply the amount to ...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~206-~206: Possible missing comma found.
Context: ...ulation. In order to successfully burn supply the amount to burn must be held by the ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~247-~247: Possible missing article found.
Context: ...on (viaauthz) to do the transfer. If force transfer is allowed for the marker, the...(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~258-~258: The preposition ‘to’ seems more likely in this position.
Context: ...ntly have the "transfer" access granted on the marker - The marker types is not ...(AI_HYDRA_LEO_REPLACE_ON_TO)
[grammar] ~258-~258: This phrase is duplicated. You should probably use “the marker” only once.
Context: ...y have the "transfer" access granted on the marker - The marker types is notRESTRICTED_COIN## Msg/...(PHRASE_REPETITION)
[uncategorized] ~263-~263: Possible missing comma found.
Context: ...send_enabled` flag disabled by the bank module and thus cannot be sent using a normal ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~265-~265: Possible missing comma found.
Context: ...ature from an account with the transfer permission as well as approval from the account th...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~364-~364: The verb ‘deny’ does not usually follow articles like ‘the’. Check that ‘deny’ is spelled correctly; using ‘deny’ as a noun may be non-standard.
Context: ...proposal to add and remove addresses to the deny send list for a restricted marker. +++...(A_INFINITIVE)
[uncategorized] ~409-~409: The preposition ‘to’ seems more likely in this position.
Context: ...ccount and does not have deposit access on the marker. - The provided value is too...(AI_HYDRA_LEO_REPLACE_ON_TO)
x/metadata/spec/03_messages.md
[misspelling] ~54-~54: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...e_uuid` field is optional. It should be a uuid formated as a string using the sta...(EN_A_VS_AN)
[misspelling] ~343-~343: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...c_uuid` field is optional. It should be a uuid formated as a string using the sta...(EN_A_VS_AN)
[misspelling] ~396-~396: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...c_uuid` field is optional. It should be a uuid formated as a string using the sta...(EN_A_VS_AN)
[misspelling] ~499-~499: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...c_uuid` field is optional. It should be a uuid formated as a string using the sta...(EN_A_VS_AN)
Markdownlint
x/trigger/spec/07_genesis.md
14-14: null
Bare URL used(MD034, no-bare-urls)
x/oracle/spec/06_genesis.md
10-10: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
18-18: null
Bare URL used(MD034, no-bare-urls)
x/trigger/spec/04_queries.md
10-10: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
11-11: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
21-21: null
Bare URL used(MD034, no-bare-urls)
27-27: null
Bare URL used(MD034, no-bare-urls)
37-37: null
Bare URL used(MD034, no-bare-urls)
41-41: null
Bare URL used(MD034, no-bare-urls)
x/oracle/spec/04_queries.md
10-10: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
11-11: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
19-19: null
Bare URL used(MD034, no-bare-urls)
23-23: null
Bare URL used(MD034, no-bare-urls)
32-32: null
Bare URL used(MD034, no-bare-urls)
36-36: null
Bare URL used(MD034, no-bare-urls)
x/hold/spec/04_queries.md
16-16: null
Bare URL used(MD034, no-bare-urls)
20-20: null
Bare URL used(MD034, no-bare-urls)
33-33: null
Bare URL used(MD034, no-bare-urls)
37-37: null
Bare URL used(MD034, no-bare-urls)
41-41: null
Bare URL used(MD034, no-bare-urls)
x/oracle/spec/03_messages.md
28-28: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
29-29: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
44-44: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
10-10: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
11-11: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
21-21: null
Bare URL used(MD034, no-bare-urls)
25-25: null
Bare URL used(MD034, no-bare-urls)
37-37: null
Bare URL used(MD034, no-bare-urls)
41-41: null
Bare URL used(MD034, no-bare-urls)
x/trigger/spec/03_messages.md
27-27: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
10-10: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
11-11: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
20-20: null
Bare URL used(MD034, no-bare-urls)
24-24: null
Bare URL used(MD034, no-bare-urls)
30-30: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
31-31: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
46-46: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
39-39: null
Bare URL used(MD034, no-bare-urls)
43-43: null
Bare URL used(MD034, no-bare-urls)
x/exchange/spec/06_params.md
26-26: null
Bare URL used(MD034, no-bare-urls)
30-30: null
Bare URL used(MD034, no-bare-urls)
x/sanction/spec/03_messages.md
15-15: null
Bare URL used(MD034, no-bare-urls)
34-34: null
Bare URL used(MD034, no-bare-urls)
52-52: null
Bare URL used(MD034, no-bare-urls)
x/quarantine/spec/05_queries.md
34-34: null
Bare URL used(MD034, no-bare-urls)
39-39: null
Bare URL used(MD034, no-bare-urls)
63-63: null
Bare URL used(MD034, no-bare-urls)
68-68: null
Bare URL used(MD034, no-bare-urls)
x/sanction/spec/05_queries.md
60-60: null
Bare URL used(MD034, no-bare-urls)
65-65: null
Bare URL used(MD034, no-bare-urls)
70-70: null
Bare URL used(MD034, no-bare-urls)
x/trigger/spec/02_state.md
28-28: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
29-29: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
31-31: null
Bare URL used(MD034, no-bare-urls)
67-67: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
68-68: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
69-69: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
41-41: null
Bare URL used(MD034, no-bare-urls)
47-47: null
Bare URL used(MD034, no-bare-urls)
53-53: null
Bare URL used(MD034, no-bare-urls)
59-59: null
Bare URL used(MD034, no-bare-urls)
71-71: null
Bare URL used(MD034, no-bare-urls)
x/quarantine/spec/03_messages.md
15-15: null
Bare URL used(MD034, no-bare-urls)
24-24: null
Bare URL used(MD034, no-bare-urls)
34-34: null
Bare URL used(MD034, no-bare-urls)
50-50: null
Bare URL used(MD034, no-bare-urls)
58-58: null
Bare URL used(MD034, no-bare-urls)
77-77: null
Bare URL used(MD034, no-bare-urls)
x/marker/spec/10_governance.md
31-31: null
Bare URL used(MD034, no-bare-urls)
47-47: null
Bare URL used(MD034, no-bare-urls)
58-58: null
Bare URL used(MD034, no-bare-urls)
74-74: null
Bare URL used(MD034, no-bare-urls)
87-87: null
Bare URL used(MD034, no-bare-urls)
99-99: null
Bare URL used(MD034, no-bare-urls)
114-114: null
Bare URL used(MD034, no-bare-urls)
125-125: null
Bare URL used(MD034, no-bare-urls)
x/exchange/spec/02_state.md
223-223: null
Bare URL used(MD034, no-bare-urls)
x/marker/spec/01_state.md
27-27: Column: 1
Hard tabs(MD010, no-hard-tabs)
23-23: null
Bare URL used(MD034, no-bare-urls)
188-188: null
Bare URL used(MD034, no-bare-urls)
197-197: null
Bare URL used(MD034, no-bare-urls)
x/exchange/spec/05_queries.md
51-51: null
Bare URL used(MD034, no-bare-urls)
57-57: null
Bare URL used(MD034, no-bare-urls)
66-66: null
Bare URL used(MD034, no-bare-urls)
70-70: null
Bare URL used(MD034, no-bare-urls)
74-74: null
Bare URL used(MD034, no-bare-urls)
85-85: null
Bare URL used(MD034, no-bare-urls)
89-89: null
Bare URL used(MD034, no-bare-urls)
103-103: null
Bare URL used(MD034, no-bare-urls)
107-107: null
Bare URL used(MD034, no-bare-urls)
121-121: null
Bare URL used(MD034, no-bare-urls)
125-125: null
Bare URL used(MD034, no-bare-urls)
139-139: null
Bare URL used(MD034, no-bare-urls)
143-143: null
Bare URL used(MD034, no-bare-urls)
156-156: null
Bare URL used(MD034, no-bare-urls)
160-160: null
Bare URL used(MD034, no-bare-urls)
171-171: null
Bare URL used(MD034, no-bare-urls)
175-175: null
Bare URL used(MD034, no-bare-urls)
184-184: null
Bare URL used(MD034, no-bare-urls)
188-188: null
Bare URL used(MD034, no-bare-urls)
197-197: null
Bare URL used(MD034, no-bare-urls)
201-201: null
Bare URL used(MD034, no-bare-urls)
210-210: null
Bare URL used(MD034, no-bare-urls)
214-214: null
Bare URL used(MD034, no-bare-urls)
223-223: null
Bare URL used(MD034, no-bare-urls)
227-227: null
Bare URL used(MD034, no-bare-urls)
238-238: null
Bare URL used(MD034, no-bare-urls)
242-242: null
Bare URL used(MD034, no-bare-urls)
246-246: null
Bare URL used(MD034, no-bare-urls)
255-255: null
Bare URL used(MD034, no-bare-urls)
259-259: null
Bare URL used(MD034, no-bare-urls)
270-270: null
Bare URL used(MD034, no-bare-urls)
276-276: null
Bare URL used(MD034, no-bare-urls)
291-291: null
Bare URL used(MD034, no-bare-urls)
297-297: null
Bare URL used(MD034, no-bare-urls)
308-308: null
Bare URL used(MD034, no-bare-urls)
312-312: null
Bare URL used(MD034, no-bare-urls)
327-327: null
Bare URL used(MD034, no-bare-urls)
333-333: null
Bare URL used(MD034, no-bare-urls)
342-342: null
Bare URL used(MD034, no-bare-urls)
346-346: null
Bare URL used(MD034, no-bare-urls)
359-359: null
Bare URL used(MD034, no-bare-urls)
363-363: null
Bare URL used(MD034, no-bare-urls)
376-376: null
Bare URL used(MD034, no-bare-urls)
380-380: null
Bare URL used(MD034, no-bare-urls)
393-393: null
Bare URL used(MD034, no-bare-urls)
397-397: null
Bare URL used(MD034, no-bare-urls)
408-408: null
Bare URL used(MD034, no-bare-urls)
414-414: null
Bare URL used(MD034, no-bare-urls)
x/metadata/spec/02_state.md
41-41: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
46-46: null
Bare URL used(MD034, no-bare-urls)
111-111: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
116-116: null
Bare URL used(MD034, no-bare-urls)
168-168: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
173-173: null
Bare URL used(MD034, no-bare-urls)
224-224: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
229-229: null
Bare URL used(MD034, no-bare-urls)
289-289: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
294-294: null
Bare URL used(MD034, no-bare-urls)
356-356: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
361-361: null
Bare URL used(MD034, no-bare-urls)
407-407: null
Bare URL used(MD034, no-bare-urls)
x/metadata/spec/05_queries.md
42-42: null
Bare URL used(MD034, no-bare-urls)
47-47: null
Bare URL used(MD034, no-bare-urls)
56-56: null
Bare URL used(MD034, no-bare-urls)
76-76: null
Bare URL used(MD034, no-bare-urls)
87-87: null
Bare URL used(MD034, no-bare-urls)
92-92: null
Bare URL used(MD034, no-bare-urls)
101-101: null
Bare URL used(MD034, no-bare-urls)
130-130: null
Bare URL used(MD034, no-bare-urls)
141-141: null
Bare URL used(MD034, no-bare-urls)
146-146: null
Bare URL used(MD034, no-bare-urls)
155-155: null
Bare URL used(MD034, no-bare-urls)
179-179: null
Bare URL used(MD034, no-bare-urls)
190-190: null
Bare URL used(MD034, no-bare-urls)
195-195: null
Bare URL used(MD034, no-bare-urls)
208-208: null
Bare URL used(MD034, no-bare-urls)
213-213: null
Bare URL used(MD034, no-bare-urls)
224-224: null
Bare URL used(MD034, no-bare-urls)
229-229: null
Bare URL used(MD034, no-bare-urls)
238-238: null
Bare URL used(MD034, no-bare-urls)
244-244: null
Bare URL used(MD034, no-bare-urls)
255-255: null
Bare URL used(MD034, no-bare-urls)
260-260: null
Bare URL used(MD034, no-bare-urls)
269-269: null
Bare URL used(MD034, no-bare-urls)
281-281: null
Bare URL used(MD034, no-bare-urls)
292-292: null
Bare URL used(MD034, no-bare-urls)
297-297: null
Bare URL used(MD034, no-bare-urls)
309-309: null
Bare URL used(MD034, no-bare-urls)
317-317: null
Bare URL used(MD034, no-bare-urls)
326-326: null
Bare URL used(MD034, no-bare-urls)
338-338: null
Bare URL used(MD034, no-bare-urls)
349-349: null
Bare URL used(MD034, no-bare-urls)
354-354: null
Bare URL used(MD034, no-bare-urls)
364-364: null
Bare URL used(MD034, no-bare-urls)
369-369: null
Bare URL used(MD034, no-bare-urls)
379-379: null
Bare URL used(MD034, no-bare-urls)
384-384: null
Bare URL used(MD034, no-bare-urls)
393-393: null
Bare URL used(MD034, no-bare-urls)
398-398: null
Bare URL used(MD034, no-bare-urls)
407-407: null
Bare URL used(MD034, no-bare-urls)
412-412: null
Bare URL used(MD034, no-bare-urls)
421-421: null
Bare URL used(MD034, no-bare-urls)
427-427: null
Bare URL used(MD034, no-bare-urls)
438-438: null
Bare URL used(MD034, no-bare-urls)
443-443: null
Bare URL used(MD034, no-bare-urls)
451-451: null
Bare URL used(MD034, no-bare-urls)
456-456: null
Bare URL used(MD034, no-bare-urls)
x/marker/spec/03_messages.md
8-8: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
9-9: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
10-10: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
11-11: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
12-12: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
13-13: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
14-14: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
15-15: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
16-16: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
17-17: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
18-18: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
19-19: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
20-20: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
21-21: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
22-22: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
23-23: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
24-24: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
25-25: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
26-26: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
27-27: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
28-28: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
37-37: null
Bare URL used(MD034, no-bare-urls)
39-39: null
Bare URL used(MD034, no-bare-urls)
69-69: null
Bare URL used(MD034, no-bare-urls)
71-71: null
Bare URL used(MD034, no-bare-urls)
92-92: null
Bare URL used(MD034, no-bare-urls)
94-94: null
Bare URL used(MD034, no-bare-urls)
111-111: null
Bare URL used(MD034, no-bare-urls)
113-113: null
Bare URL used(MD034, no-bare-urls)
129-129: null
Bare URL used(MD034, no-bare-urls)
131-131: null
Bare URL used(MD034, no-bare-urls)
152-152: null
Bare URL used(MD034, no-bare-urls)
154-154: null
Bare URL used(MD034, no-bare-urls)
172-172: null
Bare URL used(MD034, no-bare-urls)
174-174: null
Bare URL used(MD034, no-bare-urls)
190-190: null
Bare URL used(MD034, no-bare-urls)
192-192: null
Bare URL used(MD034, no-bare-urls)
208-208: null
Bare URL used(MD034, no-bare-urls)
210-210: null
Bare URL used(MD034, no-bare-urls)
227-227: null
Bare URL used(MD034, no-bare-urls)
229-229: null
Bare URL used(MD034, no-bare-urls)
238-238: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
238-238: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
250-250: null
Bare URL used(MD034, no-bare-urls)
252-252: null
Bare URL used(MD034, no-bare-urls)
267-267: null
Bare URL used(MD034, no-bare-urls)
269-269: null
Bare URL used(MD034, no-bare-urls)
277-277: null
Bare URL used(MD034, no-bare-urls)
279-279: null
Bare URL used(MD034, no-bare-urls)
293-293: Expected: 6; Actual: 8
Unordered list indentation(MD007, ul-indent)
294-294: Expected: 6; Actual: 8
Unordered list indentation(MD007, ul-indent)
300-300: null
Bare URL used(MD034, no-bare-urls)
302-302: null
Bare URL used(MD034, no-bare-urls)
319-319: null
Bare URL used(MD034, no-bare-urls)
321-321: null
Bare URL used(MD034, no-bare-urls)
335-335: null
Bare URL used(MD034, no-bare-urls)
337-337: null
Bare URL used(MD034, no-bare-urls)
351-351: null
Bare URL used(MD034, no-bare-urls)
353-353: null
Bare URL used(MD034, no-bare-urls)
366-366: null
Bare URL used(MD034, no-bare-urls)
368-368: null
Bare URL used(MD034, no-bare-urls)
384-384: null
Bare URL used(MD034, no-bare-urls)
386-386: null
Bare URL used(MD034, no-bare-urls)
399-399: null
Bare URL used(MD034, no-bare-urls)
401-401: null
Bare URL used(MD034, no-bare-urls)
416-416: null
Bare URL used(MD034, no-bare-urls)
418-418: null
Bare URL used(MD034, no-bare-urls)
x/metadata/spec/03_messages.md
51-51: null
Bare URL used(MD034, no-bare-urls)
63-63: null
Bare URL used(MD034, no-bare-urls)
83-83: null
Bare URL used(MD034, no-bare-urls)
87-87: null
Bare URL used(MD034, no-bare-urls)
102-102: null
Bare URL used(MD034, no-bare-urls)
106-106: null
Bare URL used(MD034, no-bare-urls)
122-122: null
Bare URL used(MD034, no-bare-urls)
126-126: null
Bare URL used(MD034, no-bare-urls)
141-141: null
Bare URL used(MD034, no-bare-urls)
145-145: null
Bare URL used(MD034, no-bare-urls)
162-162: null
Bare URL used(MD034, no-bare-urls)
166-166: null
Bare URL used(MD034, no-bare-urls)
182-182: null
Bare URL used(MD034, no-bare-urls)
186-186: null
Bare URL used(MD034, no-bare-urls)
202-202: null
Bare URL used(MD034, no-bare-urls)
206-206: null
Bare URL used(MD034, no-bare-urls)
224-224: null
Bare URL used(MD034, no-bare-urls)
235-235: null
Bare URL used(MD034, no-bare-urls)
262-262: null
Bare URL used(MD034, no-bare-urls)
273-273: null
Bare URL used(MD034, no-bare-urls)
315-315: null
Bare URL used(MD034, no-bare-urls)
319-319: null
Bare URL used(MD034, no-bare-urls)
340-340: null
Bare URL used(MD034, no-bare-urls)
348-348: null
Bare URL used(MD034, no-bare-urls)
372-372: null
Bare URL used(MD034, no-bare-urls)
376-376: null
Bare URL used(MD034, no-bare-urls)
393-393: null
Bare URL used(MD034, no-bare-urls)
401-401: null
Bare URL used(MD034, no-bare-urls)
429-429: null
Bare URL used(MD034, no-bare-urls)
433-433: null
Bare URL used(MD034, no-bare-urls)
449-449: null
Bare URL used(MD034, no-bare-urls)
453-453: null
Bare URL used(MD034, no-bare-urls)
472-472: null
Bare URL used(MD034, no-bare-urls)
476-476: null
Bare URL used(MD034, no-bare-urls)
496-496: null
Bare URL used(MD034, no-bare-urls)
504-504: null
Bare URL used(MD034, no-bare-urls)
531-531: null
Bare URL used(MD034, no-bare-urls)
535-535: null
Bare URL used(MD034, no-bare-urls)
553-553: null
Bare URL used(MD034, no-bare-urls)
557-557: null
Bare URL used(MD034, no-bare-urls)
576-576: null
Bare URL used(MD034, no-bare-urls)
580-580: null
Bare URL used(MD034, no-bare-urls)
601-601: null
Bare URL used(MD034, no-bare-urls)
605-605: null
Bare URL used(MD034, no-bare-urls)
629-629: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
624-624: null
Bare URL used(MD034, no-bare-urls)
626-626: null
Bare URL used(MD034, no-bare-urls)
x/exchange/spec/03_messages.md
68-68: null
Bare URL used(MD034, no-bare-urls)
72-72: null
Bare URL used(MD034, no-bare-urls)
76-76: null
Bare URL used(MD034, no-bare-urls)
101-101: null
Bare URL used(MD034, no-bare-urls)
105-105: null
Bare URL used(MD034, no-bare-urls)
109-109: null
Bare URL used(MD034, no-bare-urls)
126-126: null
Bare URL used(MD034, no-bare-urls)
130-130: null
Bare URL used(MD034, no-bare-urls)
152-152: null
Bare URL used(MD034, no-bare-urls)
156-156: null
Bare URL used(MD034, no-bare-urls)
183-183: null
Bare URL used(MD034, no-bare-urls)
187-187: null
Bare URL used(MD034, no-bare-urls)
214-214: null
Bare URL used(MD034, no-bare-urls)
218-218: null
Bare URL used(MD034, no-bare-urls)
253-253: null
Bare URL used(MD034, no-bare-urls)
257-257: null
Bare URL used(MD034, no-bare-urls)
274-274: null
Bare URL used(MD034, no-bare-urls)
278-278: null
Bare URL used(MD034, no-bare-urls)
295-295: null
Bare URL used(MD034, no-bare-urls)
299-299: null
Bare URL used(MD034, no-bare-urls)
321-321: null
Bare URL used(MD034, no-bare-urls)
325-325: null
Bare URL used(MD034, no-bare-urls)
342-342: null
Bare URL used(MD034, no-bare-urls)
346-346: null
Bare URL used(MD034, no-bare-urls)
361-361: null
Bare URL used(MD034, no-bare-urls)
367-367: null
Bare URL used(MD034, no-bare-urls)
384-384: null
Bare URL used(MD034, no-bare-urls)
388-388: null
Bare URL used(MD034, no-bare-urls)
406-406: null
Bare URL used(MD034, no-bare-urls)
410-410: null
Bare URL used(MD034, no-bare-urls)
429-429: null
Bare URL used(MD034, no-bare-urls)
433-433: null
Bare URL used(MD034, no-bare-urls)
448-448: null
Bare URL used(MD034, no-bare-urls)
452-452: null
Bare URL used(MD034, no-bare-urls)
469-469: null
Bare URL used(MD034, no-bare-urls)
475-475: null
Bare URL used(MD034, no-bare-urls)
493-493: null
Bare URL used(MD034, no-bare-urls)
497-497: null
Bare URL used(MD034, no-bare-urls)
530-530: null
Bare URL used(MD034, no-bare-urls)
534-534: null
Bare URL used(MD034, no-bare-urls)
538-538: null
Bare URL used(MD034, no-bare-urls)
557-557: null
Bare URL used(MD034, no-bare-urls)
563-563: null
Bare URL used(MD034, no-bare-urls)
578-578: null
Bare URL used(MD034, no-bare-urls)
582-582: null
Bare URL used(MD034, no-bare-urls)
597-597: null
Bare URL used(MD034, no-bare-urls)
601-601: null
Bare URL used(MD034, no-bare-urls)
616-616: null
Bare URL used(MD034, no-bare-urls)
620-620: null
Bare URL used(MD034, no-bare-urls)
640-640: null
Bare URL used(MD034, no-bare-urls)
644-644: null
Bare URL used(MD034, no-bare-urls)
680-680: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
681-681: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
670-670: null
Bare URL used(MD034, no-bare-urls)
674-674: null
Bare URL used(MD034, no-bare-urls)
678-678: null
Bare URL used(MD034, no-bare-urls)
687-687: null
Bare URL used(MD034, no-bare-urls)
691-691: null
Bare URL used(MD034, no-bare-urls)
695-695: null
Bare URL used(MD034, no-bare-urls)
699-699: null
Bare URL used(MD034, no-bare-urls)
713-713: null
Bare URL used(MD034, no-bare-urls)
719-719: null
Bare URL used(MD034, no-bare-urls)
733-733: null
Bare URL used(MD034, no-bare-urls)
737-737: null
Bare URL used(MD034, no-bare-urls)
749-749: null
Bare URL used(MD034, no-bare-urls)
755-755: null
Bare URL used(MD034, no-bare-urls)
CHANGELOG.md
50-50: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
Shellcheck
scripts/update-spec-links.sh
[warning] 65-65: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.
(SC2164)
[warning] 258-258: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
(SC2207)
[warning] 303-303: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
(SC2207)
[warning] 325-325: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
(SC2207)
Additional comments not posted (35)
scripts/identify-messages.awk (5)
24-34: LGTM!The comments explaining the limitations of the script are clear and informative.
35-47: LGTM!The logic for identifying message start and end lines is clear and well-structured.
48-78: LGTM!The logic for extracting message names and handling comments is clear and well-structured.
79-99: LGTM!The logic for outputting message details is clear and well-structured.
100-100: LGTM!The closing brace is correctly placed.
x/metadata/spec/02_state.md (6)
46-46: LGTM!The link to the
Scopemessage inscope.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
46-46: null
Bare URL used(MD034, no-bare-urls)
116-116: LGTM!The link to the
Sessionmessage inscope.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
116-116: null
Bare URL used(MD034, no-bare-urls)
173-173: LGTM!The link to the
Recordmessage inscope.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
173-173: null
Bare URL used(MD034, no-bare-urls)
229-229: LGTM!The link to the
ScopeSpecificationmessage inspecification.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
229-229: null
Bare URL used(MD034, no-bare-urls)
294-294: LGTM!The link to the
ContractSpecificationmessage inspecification.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
294-294: null
Bare URL used(MD034, no-bare-urls)
361-361: LGTM!The link to the
RecordSpecificationmessage inspecification.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
361-361: null
Bare URL used(MD034, no-bare-urls)
x/metadata/spec/05_queries.md (15)
42-42: LGTM!The link to the
Paramsquery request inquery.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
42-42: null
Bare URL used(MD034, no-bare-urls)
47-47: LGTM!The link to the
Paramsquery response inquery.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
47-47: null
Bare URL used(MD034, no-bare-urls)
56-56: LGTM!The link to the
Scopequery request inquery.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
56-56: null
Bare URL used(MD034, no-bare-urls)
76-76: LGTM!The link to the
Scopequery response inquery.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
76-76: null
Bare URL used(MD034, no-bare-urls)
87-87: LGTM!The link to the
ScopesAllquery request inquery.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
87-87: null
Bare URL used(MD034, no-bare-urls)
92-92: LGTM!The link to the
ScopesAllquery response inquery.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
92-92: null
Bare URL used(MD034, no-bare-urls)
101-101: LGTM!The link to the
Sessionsquery request inquery.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
101-101: null
Bare URL used(MD034, no-bare-urls)
130-130: LGTM!The link to the
Sessionsquery response inquery.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
130-130: null
Bare URL used(MD034, no-bare-urls)
141-141: LGTM!The link to the
SessionsAllquery request inquery.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
141-141: null
Bare URL used(MD034, no-bare-urls)
146-146: LGTM!The link to the
SessionsAllquery response inquery.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
146-146: null
Bare URL used(MD034, no-bare-urls)
155-155: LGTM!The link to the
Recordsquery request inquery.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
155-155: null
Bare URL used(MD034, no-bare-urls)
179-179: LGTM!The link to the
Recordsquery response inquery.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
179-179: null
Bare URL used(MD034, no-bare-urls)
190-190: LGTM!The link to the
RecordsAllquery request inquery.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
190-190: null
Bare URL used(MD034, no-bare-urls)
195-195: LGTM!The link to the
RecordsAllquery response inquery.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
195-195: null
Bare URL used(MD034, no-bare-urls)
208-208: LGTM!The link to the
Ownershipquery request inquery.protohas been updated correctly to reference versionv1.19.0.Tools
Markdownlint
208-208: null
Bare URL used(MD034, no-bare-urls)
scripts/update-spec-links.sh (6)
2-24: LGTM! Usage instructions are clear and comprehensive.The usage instructions provide a detailed explanation of the script's functionality and options.
25-220: LGTM! Argument parsing logic is correct and handles all options appropriately.The argument parsing logic is comprehensive and correctly processes all provided options and flags.
Tools
Shellcheck
[warning] 65-65: Use 'cd ... || exit' or 'cd ... || return' in case cd fails.
(SC2164)
221-285: LGTM! File identification logic is correct and handles all edge cases.The file identification logic accurately identifies markdown files that need to be updated.
Tools
Shellcheck
[warning] 258-258: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
(SC2207)
286-402: LGTM! Proto file handling logic is correct and handles errors appropriately.The proto file handling logic accurately manages downloading or copying proto files and handles errors effectively.
Tools
Shellcheck
[warning] 303-303: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
(SC2207)
[warning] 325-325: Prefer mapfile or read -a to split command output (or quote to avoid splitting).
(SC2207)
403-657: LGTM! Link processing logic is correct and handles errors appropriately.The link processing logic accurately identifies messages and endpoints, creates updated links, and handles errors effectively.
658-718: LGTM! Markdown file updating logic is correct and handles errors appropriately.The markdown file updating logic accurately updates the markdown files with the new links and handles errors effectively.
CHANGELOG.md (2)
40-43: LGTM!The new feature entry is well-documented and linked to the relevant pull request.
44-46: LGTM!The improvement entry is well-documented and linked to the relevant pull request.
x/metadata/spec/03_messages.md (1)
54-54: Use "an" instead of "a".Correct the article usage before "uuid".
- It should be a uuid formated as a string using the standard UUID format. + It should be an uuid formated as a string using the standard UUID format.Likely invalid or redundant comment.
Tools
LanguageTool
[misspelling] ~54-~54: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...e_uuid` field is optional. It should be a uuid formated as a string using the sta...(EN_A_VS_AN)
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- CHANGELOG.md (1 hunks)
Additional context used
Markdownlint
CHANGELOG.md
50-50: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
Additional comments not posted (2)
CHANGELOG.md (2)
40-42: LGTM!The entry for creating a script to update links in the spec docs to proto messages is clear and follows the changelog guidelines.
44-46: LGTM!The entry for updating all the proto links in the spec docs to point to
v1.19.0versions of the proto files is clear and follows the changelog guidelines.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- CHANGELOG.md (1 hunks)
Additional context used
Markdownlint
CHANGELOG.md
50-50: Expected: asterisk; Actual: dash
Unordered list style(MD004, ul-style)
Additional comments not posted (2)
CHANGELOG.md (2)
40-43: Entry for new script looks good.The entry accurately describes the new script for updating links in the spec docs and follows the changelog format.
44-46: Entry for updating proto links looks good.The entry accurately describes the improvement of updating proto links in the spec docs and follows the changelog format.
…t for v1.19.0 (#2068) * Fix one of the marker tx proto links that had a double slash. * Create the beginnings of a script that will update links. It currently just has argument parsing and file identification. * Add stuff that identifies all the needed proto files and copies/downloads them into a temp dir. * Identify the messages and their line numbers from the protos, the endpoints and their messages also from the protos, and identify all the links and their messages from the markdown files. * Output a message at each step of the way. * Fix bug in the identify-links awk script that always caused link messages to generate an error. * Fix all the problematic entries in the spec docs. * Finish the script. * Fix some entries that were looking for the wrong message name. * Final script fixes. * Update some documentation in the new script stuff. Add better control over output. Make it possible to have the script only do cleanup on success. * Run the script to update all the links to v1.19.0-rc2. That's already been published, so I was able to click on all the links to verify that they are correct. * Run the script again to change them all to v1.19.0 (which doesn't exist yet). I verified that the only diffs were the removal of the '-rc2' from all of the links. I.e. file and line numbers stayed the same. * Tweak the comments in the awk scripts after some proofreading. * Actually do the defined cleanup action (always) when no option is provided. Tweak some of the comments from proofreading. * Add changelog entry.
…t for v1.19.0 (#2068) (#2074) * Fix one of the marker tx proto links that had a double slash. * Create the beginnings of a script that will update links. It currently just has argument parsing and file identification. * Add stuff that identifies all the needed proto files and copies/downloads them into a temp dir. * Identify the messages and their line numbers from the protos, the endpoints and their messages also from the protos, and identify all the links and their messages from the markdown files. * Output a message at each step of the way. * Fix bug in the identify-links awk script that always caused link messages to generate an error. * Fix all the problematic entries in the spec docs. * Finish the script. * Fix some entries that were looking for the wrong message name. * Final script fixes. * Update some documentation in the new script stuff. Add better control over output. Make it possible to have the script only do cleanup on success. * Run the script to update all the links to v1.19.0-rc2. That's already been published, so I was able to click on all the links to verify that they are correct. * Run the script again to change them all to v1.19.0 (which doesn't exist yet). I verified that the only diffs were the removal of the '-rc2' from all of the links. I.e. file and line numbers stayed the same. * Tweak the comments in the awk scripts after some proofreading. * Actually do the defined cleanup action (always) when no option is provided. Tweak some of the comments from proofreading. * Add changelog entry. Co-authored-by: Ira Miller <72319+iramiller@users.noreply.github.com>
Description
This PR adds a bash script (and some awk scripts) for finding and updating all of the links to our proto files that are in our spec docs:
scripts/update-spec-links.shBasic usage:
You can provide the
--helpflag to get more detailed usage info.The script will go through all
<file or dir>s provided to identify which are markdown files with an updatable link. Not providing any is the same as providing just..To update all the spec doc links for this PR, here's the command that I ran:
If you only wanted to update the links for the
x/markermodule, you could run this:The links in question are the ones like this:
+++ https://github.com/provenance-io/provenance/blob/3b77d267d4336deba89fc2196243e80952de51a1/proto/provenance/metadata/v1/query.proto#L845-L849The script uses the headers in the spec docs to identify what content a link should have. See the comments in
identify-links.awkfor details on the patterns it uses to identify the links from the context above the link.Note: I updated all the links to use tag
v1.19.0which doesn't exist at the time of writing this. I felt it best to reference released versions of the protos. But to do that, there will have to be a period where none of the links inmainorrelease/v1.19.xactually work. But oncev1.19.0is tagged, causing the release to be created, they'll all work and reference that version.I had to lightly tweak a few of the spec docs so that this script worked everywhere that we have. I stopped short of trying to standardize all of our spec docs though because we don't really have that standard defined, and would make it harder to evaluate this PR.
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/)godoccomments.Unreleasedsection inCHANGELOG.mdFiles changedin the Github PR explorerCodecov Reportin the comment section below once CI passesSummary by CodeRabbit
New Features
v1.19.0versions.Chores