Escape the brackets in sanction and quarantine docs.

[SpicyLemon]

Description

The non escaped brackets are breaking the dev-portal. Need to have them escaped for the docusaurus renderer.

---

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.

• Targeted PR against correct branch (see CONTRIBUTING.md)
• Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
• Wrote unit and integration tests
• Updated relevant documentation (docs/) or specification (x/<module>/spec/)
• Added relevant godoc comments.
• Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
• Re-reviewed Files changed in the Github PR explorer
• Review Codecov Report in the comment section below once CI passes

Summary by CodeRabbit

• Documentation
  • Updated event attribute values in quarantine and sanction operations to properly escape curly braces for better clarity and consistency.

[coderabbitai]

Walkthrough

The recent changes primarily involve escaping curly braces in attribute values for event types related to quarantine and sanction operations. This alteration ensures that curly braces are properly interpreted in the context of event attributes, enhancing the clarity and accuracy of event data representation.

Changes

File Path	Change Summary
x/quarantine/spec/04_events.md	Escaped curly braces in attribute values for to_address and coins in various quarantine events.
x/sanction/spec/04_events.md	Escaped curly braces in attribute values for sanctioned and unsanctioned account addresses.

In the code where changes bloom,
Curly braces found their room.
Sanctions, quarantines aligned,
Events now clear, well-defined.
A rabbit's joy, in code's embrace,
Hopping through this tidy space. 🐇

---

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 81cca66 and 31dcef5.

Files selected for processing (2)

• x/quarantine/spec/04_events.md (2 hunks)
• x/sanction/spec/04_events.md (1 hunks)

Additional Context Used

LanguageTool (10)

x/quarantine/spec/04_events.md (5)

Near line 15: Loose punctuation mark.
Context: ...n account opts into quarantine. @Type: /cosmos.quarantine.v1beta1.EventOptIn...
Rule ID: UNLIKELY_OPENING_PUNCTUATION

---

Near line 25: Loose punctuation mark.
Context: ...account opts out of quarantine. @Type: `/cosmos.quarantine.v1beta1.EventOptOut...
Rule ID: UNLIKELY_OPENING_PUNCTUATION

---

Near line 33: It seems likely that a singular genitive (’s) apostrophe is missing.
Context: ...x/bank module will be the quarantined funds holder account instead of the intended ...
Rule ID: AI_HYDRA_LEO_APOSTROPHE_S_XS

---

Near line 36: Loose punctuation mark.
Context: ...ollowing event is also emitted. @Type: `/cosmos.quarantine.v1beta1.EventFundsQ...
Rule ID: UNLIKELY_OPENING_PUNCTUATION

---

Near line 47: Loose punctuation mark.
Context: ... originally intended recipient. @Type: `/cosmos.quarantine.v1beta1.EventFundsR...
Rule ID: UNLIKELY_OPENING_PUNCTUATION

x/sanction/spec/04_events.md (5)

Near line 16: Loose punctuation mark.
Context: ... when an account is sanctioned. @Type: `/cosmos.sanction.v1beta1.EventAddressS...
Rule ID: UNLIKELY_OPENING_PUNCTUATION

---

Near line 26: Loose punctuation mark.
Context: ...hen an account is unsanctioned. @Type: `/cosmos.sanction.v1beta1.EventAddressU...
Rule ID: UNLIKELY_OPENING_PUNCTUATION

---

Near line 36: Loose punctuation mark.
Context: ...nction is placed on an account. @Type: `/cosmos.sanction.v1beta1.EventTempAddr...
Rule ID: UNLIKELY_OPENING_PUNCTUATION

---

Near line 46: Loose punctuation mark.
Context: ...nction is placed on an account. @Type: `/cosmos.sanction.v1beta1.EventTempAddr...
Rule ID: UNLIKELY_OPENING_PUNCTUATION

---

Near line 56: Loose punctuation mark.
Context: ...nmodule's params are updated. @type: /cosmos.sanction.v1beta1.EventParamsUp...
Rule ID: UNLIKELY_OPENING_PUNCTUATION

Markdownlint (9)

x/quarantine/spec/04_events.md (4)

6: Expected: 0; Actual: 2
Unordered list indentation

---

7: Expected: 0; Actual: 2
Unordered list indentation

---

8: Expected: 0; Actual: 2
Unordered list indentation

---

9: Expected: 0; Actual: 2
Unordered list indentation

x/sanction/spec/04_events.md (5)

6: Expected: 0; Actual: 2
Unordered list indentation

---

7: Expected: 0; Actual: 2
Unordered list indentation

---

8: Expected: 0; Actual: 2
Unordered list indentation

---

9: Expected: 0; Actual: 2
Unordered list indentation

---

10: Expected: 0; Actual: 2
Unordered list indentation

Additional comments not posted (8)

x/quarantine/spec/04_events.md (4)

19-19: Escaping curly braces ensures proper rendering in Docusaurus. Good job on this fix.

---

29-29: Proper escaping of curly braces in the attribute value. This change is consistent with the PR objectives.

---

40-41: The escaping of curly braces in both to_address and coins attributes is correctly implemented.

---

51-52: Correct implementation of escaping in the attribute values. This ensures that the documentation will render correctly in Docusaurus.

x/sanction/spec/04_events.md (4)

20-20: Correctly escaped curly braces in the attribute value, ensuring proper rendering in Docusaurus.

---

30-30: The escaping of curly braces is consistent and correct, aligning with the PR objectives.

---

40-40: Properly escaped curly braces in the attribute value. This change is consistent and necessary for correct documentation rendering.

---

50-50: The escaping of curly braces is implemented correctly across all relevant attributes, ensuring consistency and correct rendering.