From 0d3a51196e86214968855b8c320a96efaf4dc4d2 Mon Sep 17 00:00:00 2001 From: aj webb Date: Wed, 15 May 2024 10:19:19 -1000 Subject: [PATCH 1/2] Escape the brackets in sanction and quarantine docs --- x/quarantine/spec/04_events.md | 37 +++++++++++++++++----------------- x/sanction/spec/04_events.md | 37 +++++++++++++++++----------------- 2 files changed, 38 insertions(+), 36 deletions(-) diff --git a/x/quarantine/spec/04_events.md b/x/quarantine/spec/04_events.md index 10216ee66c..f04f08542b 100644 --- a/x/quarantine/spec/04_events.md +++ b/x/quarantine/spec/04_events.md @@ -3,10 +3,11 @@ The `x/quarantine` module emits the following events. - - [EventOptIn](#eventoptin) - - [EventOptOut](#eventoptout) - - [EventFundsQuarantined](#eventfundsquarantined) - - [EventFundsReleased](#eventfundsreleased) + +- [EventOptIn](#eventoptin) +- [EventOptOut](#eventoptout) +- [EventFundsQuarantined](#eventfundsquarantined) +- [EventFundsReleased](#eventfundsreleased) ## EventOptIn @@ -14,9 +15,9 @@ This event is emitted when an account opts into quarantine. `@Type`: `/cosmos.quarantine.v1beta1.EventOptIn` -| Attribute Key | Attribute Value | -|---------------|--------------------------------------| -| to_address | {bech32 string of account opting in} | +| Attribute Key | Attribute Value | +| ------------- | -------------------------------------- | +| to_address | \{bech32 string of account opting in\} | ## EventOptOut @@ -24,9 +25,9 @@ This event is emitted when an account opts out of quarantine. `@Type`: `/cosmos.quarantine.v1beta1.EventOptOut` -| Attribute Key | Attribute Value | -|---------------|---------------------------------------| -| to_address | {bech32 string of account opting out} | +| Attribute Key | Attribute Value | +| ------------- | --------------------------------------- | +| to_address | \{bech32 string of account opting out\} | ## EventFundsQuarantined @@ -35,10 +36,10 @@ The following event is also emitted. `@Type`: `/cosmos.quarantine.v1beta1.EventFundsQuarantined` -| Attribute Key | Attribute Value | -|---------------|---------------------------------------| -| to_address | {bech32 string of intended recipient} | -| coins | {sdk.Coins of funds quarantined} | +| Attribute Key | Attribute Value | +| ------------- | --------------------------------------- | +| to_address | \{bech32 string of intended recipient\} | +| coins | \{sdk.Coins of funds quarantined\} | ## EventFundsReleased @@ -46,7 +47,7 @@ This event is emitted when funds are fully accepted and sent from the quarantine `@Type`: `/cosmos.quarantine.v1beta1.EventFundsReleased` -| Attribute Key | Attribute Value | -|---------------|-------------------------------| -| to_address | {bech32 string of recipient} | -| coins | {sdk.Coins of funds released} | +| Attribute Key | Attribute Value | +| ------------- | ------------------------------- | +| to_address | \{bech32 string of recipient\} | +| coins | \{sdk.Coins of funds released\} | diff --git a/x/sanction/spec/04_events.md b/x/sanction/spec/04_events.md index 953e375e08..65244cead9 100644 --- a/x/sanction/spec/04_events.md +++ b/x/sanction/spec/04_events.md @@ -3,11 +3,12 @@ The `x/sanction` module emits the following events. - - [EventAddressSanctioned](#eventaddresssanctioned) - - [EventAddressUnsanctioned](#eventaddressunsanctioned) - - [EventTempAddressSanctioned](#eventtempaddresssanctioned) - - [EventTempAddressUnsanctioned](#eventtempaddressunsanctioned) - - [EventParamsUpdated](#eventparamsupdated) + +- [EventAddressSanctioned](#eventaddresssanctioned) +- [EventAddressUnsanctioned](#eventaddressunsanctioned) +- [EventTempAddressSanctioned](#eventtempaddresssanctioned) +- [EventTempAddressUnsanctioned](#eventtempaddressunsanctioned) +- [EventParamsUpdated](#eventparamsupdated) ## EventAddressSanctioned @@ -15,9 +16,9 @@ This event is emitted when an account is sanctioned. `@Type`: `/cosmos.sanction.v1beta1.EventAddressSanctioned` -| Attribute Key | Attribute Value | -|---------------|---------------------------------------| -| address | {bech32 string of sanctioned account} | +| Attribute Key | Attribute Value | +| ------------- | --------------------------------------- | +| address | \{bech32 string of sanctioned account\} | ## EventAddressUnsanctioned @@ -25,9 +26,9 @@ This event is emitted when an account is unsanctioned. `@Type`: `/cosmos.sanction.v1beta1.EventAddressUnsanctioned` -| Attribute Key | Attribute Value | -|---------------|-----------------------------------------| -| address | {bech32 string of unsanctioned account} | +| Attribute Key | Attribute Value | +| ------------- | ----------------------------------------- | +| address | \{bech32 string of unsanctioned account\} | ## EventTempAddressSanctioned @@ -35,9 +36,9 @@ This event is emitted when a temporary sanction is placed on an account. `@Type`: `/cosmos.sanction.v1beta1.EventTempAddressSanctioned` -| Attribute Key | Attribute Value | -|---------------|---------------------------------------| -| address | {bech32 string of sanctioned account} | +| Attribute Key | Attribute Value | +| ------------- | --------------------------------------- | +| address | \{bech32 string of sanctioned account\} | ## EventTempAddressUnsanctioned @@ -45,9 +46,9 @@ This event is emitted when a temporary unsanction is placed on an account. `@Type`: `/cosmos.sanction.v1beta1.EventTempAddressUnsanctioned` -| Attribute Key | Attribute Value | -|---------------|-----------------------------------------| -| address | {bech32 string of unsanctioned account} | +| Attribute Key | Attribute Value | +| ------------- | ----------------------------------------- | +| address | \{bech32 string of unsanctioned account\} | ## EventParamsUpdated @@ -56,5 +57,5 @@ This event is emitted when the `x/sanction` module's params are updated. `@Type`: `/cosmos.sanction.v1beta1.EventParamsUpdated` | Attribute Key | Attribute Value | -|---------------|-----------------| +| ------------- | --------------- | | (none) | | From 7950aa291da7532ad3b9503a6b428daf9d747aac Mon Sep 17 00:00:00 2001 From: aj webb Date: Mon, 20 May 2024 14:21:44 -1000 Subject: [PATCH 2/2] Reset white space --- x/quarantine/spec/04_events.md | 17 ++++++++--------- x/sanction/spec/04_events.md | 21 ++++++++++----------- 2 files changed, 18 insertions(+), 20 deletions(-) diff --git a/x/quarantine/spec/04_events.md b/x/quarantine/spec/04_events.md index f04f08542b..b08e4e5b39 100644 --- a/x/quarantine/spec/04_events.md +++ b/x/quarantine/spec/04_events.md @@ -3,11 +3,10 @@ The `x/quarantine` module emits the following events. - -- [EventOptIn](#eventoptin) -- [EventOptOut](#eventoptout) -- [EventFundsQuarantined](#eventfundsquarantined) -- [EventFundsReleased](#eventfundsreleased) + - [EventOptIn](#eventoptin) + - [EventOptOut](#eventoptout) + - [EventFundsQuarantined](#eventfundsquarantined) + - [EventFundsReleased](#eventfundsreleased) ## EventOptIn @@ -16,7 +15,7 @@ This event is emitted when an account opts into quarantine. `@Type`: `/cosmos.quarantine.v1beta1.EventOptIn` | Attribute Key | Attribute Value | -| ------------- | -------------------------------------- | +|---------------|----------------------------------------| | to_address | \{bech32 string of account opting in\} | ## EventOptOut @@ -26,7 +25,7 @@ This event is emitted when an account opts out of quarantine. `@Type`: `/cosmos.quarantine.v1beta1.EventOptOut` | Attribute Key | Attribute Value | -| ------------- | --------------------------------------- | +|---------------|-----------------------------------------| | to_address | \{bech32 string of account opting out\} | ## EventFundsQuarantined @@ -37,7 +36,7 @@ The following event is also emitted. `@Type`: `/cosmos.quarantine.v1beta1.EventFundsQuarantined` | Attribute Key | Attribute Value | -| ------------- | --------------------------------------- | +|---------------|-----------------------------------------| | to_address | \{bech32 string of intended recipient\} | | coins | \{sdk.Coins of funds quarantined\} | @@ -48,6 +47,6 @@ This event is emitted when funds are fully accepted and sent from the quarantine `@Type`: `/cosmos.quarantine.v1beta1.EventFundsReleased` | Attribute Key | Attribute Value | -| ------------- | ------------------------------- | +|---------------|---------------------------------| | to_address | \{bech32 string of recipient\} | | coins | \{sdk.Coins of funds released\} | diff --git a/x/sanction/spec/04_events.md b/x/sanction/spec/04_events.md index 65244cead9..5da604aee6 100644 --- a/x/sanction/spec/04_events.md +++ b/x/sanction/spec/04_events.md @@ -3,12 +3,11 @@ The `x/sanction` module emits the following events. - -- [EventAddressSanctioned](#eventaddresssanctioned) -- [EventAddressUnsanctioned](#eventaddressunsanctioned) -- [EventTempAddressSanctioned](#eventtempaddresssanctioned) -- [EventTempAddressUnsanctioned](#eventtempaddressunsanctioned) -- [EventParamsUpdated](#eventparamsupdated) + - [EventAddressSanctioned](#eventaddresssanctioned) + - [EventAddressUnsanctioned](#eventaddressunsanctioned) + - [EventTempAddressSanctioned](#eventtempaddresssanctioned) + - [EventTempAddressUnsanctioned](#eventtempaddressunsanctioned) + - [EventParamsUpdated](#eventparamsupdated) ## EventAddressSanctioned @@ -17,7 +16,7 @@ This event is emitted when an account is sanctioned. `@Type`: `/cosmos.sanction.v1beta1.EventAddressSanctioned` | Attribute Key | Attribute Value | -| ------------- | --------------------------------------- | +|---------------|-----------------------------------------| | address | \{bech32 string of sanctioned account\} | ## EventAddressUnsanctioned @@ -27,7 +26,7 @@ This event is emitted when an account is unsanctioned. `@Type`: `/cosmos.sanction.v1beta1.EventAddressUnsanctioned` | Attribute Key | Attribute Value | -| ------------- | ----------------------------------------- | +|---------------|-------------------------------------------| | address | \{bech32 string of unsanctioned account\} | ## EventTempAddressSanctioned @@ -37,7 +36,7 @@ This event is emitted when a temporary sanction is placed on an account. `@Type`: `/cosmos.sanction.v1beta1.EventTempAddressSanctioned` | Attribute Key | Attribute Value | -| ------------- | --------------------------------------- | +|---------------|-----------------------------------------| | address | \{bech32 string of sanctioned account\} | ## EventTempAddressUnsanctioned @@ -47,7 +46,7 @@ This event is emitted when a temporary unsanction is placed on an account. `@Type`: `/cosmos.sanction.v1beta1.EventTempAddressUnsanctioned` | Attribute Key | Attribute Value | -| ------------- | ----------------------------------------- | +|---------------|-------------------------------------------| | address | \{bech32 string of unsanctioned account\} | ## EventParamsUpdated @@ -57,5 +56,5 @@ This event is emitted when the `x/sanction` module's params are updated. `@Type`: `/cosmos.sanction.v1beta1.EventParamsUpdated` | Attribute Key | Attribute Value | -| ------------- | --------------- | +|---------------|-----------------| | (none) | |