Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Escape the brackets in sanction and quarantine docs #1974

Closed
wants to merge 9 commits into from
Closed

Escape the brackets in sanction and quarantine docs #1974

wants to merge 9 commits into from

Conversation

webbushka
Copy link
Contributor

@webbushka webbushka commented May 15, 2024 •
edited by coderabbitai bot
Loading

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

Summary by CodeRabbit

  • Documentation
    • Improved formatting for event attribute values in the quarantine and sanction specifications for better readability and alignment.

@webbushka webbushka requested a review from a team as a code owner May 15, 2024 20:19
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 15, 2024 •
edited
Loading

Walkthrough

The recent updates focus on enhancing the formatting of event specification files, ensuring better alignment and clarity in attribute values. These changes aim to improve the readability and consistency of event representations without altering their functionality.

Changes

Files Change Summaries
x/quarantine/spec/04_events.md Formatting adjustments in event tables for EventOptIn, EventOptOut, EventFundsQuarantined, and EventFundsReleased.
x/sanction/spec/04_events.md Formatting changes for address attributes in events: EventAddressSanctioned, EventAddressUnsanctioned, EventTempAddressSanctioned, EventTempAddressUnsanctioned.

🐇
In the code's quiet lanes, changes bloom,
Curly braces tamed, alignment in tune.
Events now shine with clearer grace,
A rabbit's touch in every space.
Code refined, like morning dew,
For devs like you, a gift anew.
🌸

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
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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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[bot]
coderabbitai bot reviewed May 15, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between a8bdd20 and 0d3a511.
Files selected for processing (2)
  • x/quarantine/spec/04_events.md (2 hunks)
  • x/sanction/spec/04_events.md (2 hunks)
Additional Context Used
LanguageTool (10)
x/quarantine/spec/04_events.md (5)

Near line 16: Loose punctuation mark.
Context: ...n account opts into quarantine. @Type: /cosmos.quarantine.v1beta1.EventOptIn...

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

Near line 34: 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 ...

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

Near line 48: Loose punctuation mark.
Context: ... originally intended recipient. @Type: `/cosmos.quarantine.v1beta1.EventFundsR...

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

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

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

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

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

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

Additional comments not posted (8)
x/quarantine/spec/04_events.md (4)

18-20: Escape curly braces in attribute values.

The curly braces around the attribute values have been correctly escaped to prevent rendering issues in markdown.

28-30: Escape curly braces in attribute values.

The curly braces around the attribute values have been correctly escaped to prevent rendering issues in markdown.

39-42: Escape curly braces in attribute values.

The curly braces around the attribute values have been correctly escaped to prevent rendering issues in markdown.

50-53: Escape curly braces in attribute values.

The curly braces around the attribute values have been correctly escaped to prevent rendering issues in markdown.

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

19-21: Escape curly braces in attribute values.

The curly braces around the attribute values have been correctly escaped to prevent rendering issues in markdown.

29-31: Escape curly braces in attribute values.

The curly braces around the attribute values have been correctly escaped to prevent rendering issues in markdown.

39-41: Escape curly braces in attribute values.

The curly braces around the attribute values have been correctly escaped to prevent rendering issues in markdown.

49-51: Escape curly braces in attribute values.

The curly braces around the attribute values have been correctly escaped to prevent rendering issues in markdown.

x/sanction/spec/04_events.md Outdated Show resolved Hide resolved
scirner22
scirner22 previously approved these changes May 15, 2024
View reviewed changes
@webbushka webbushka mentioned this pull request May 15, 2024
Merged
Taztingo
Taztingo previously approved these changes May 15, 2024
View reviewed changes
@webbushka
Copy link
Contributor Author

I don't have auth to merge these after they are approved if someone is willing to merge that would be appreciated.

@scirner22 @Taztingo @SpicyLemon

@webbushka webbushka dismissed stale reviews from Taztingo and scirner22 via ad2c5e4 May 21, 2024 00:22
@SpicyLemon SpicyLemon enabled auto-merge (squash) May 21, 2024 17:52
coderabbitai[bot]
coderabbitai bot reviewed May 21, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 0d3a511 and 73a1977.
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 (9)
x/quarantine/spec/04_events.md (4)

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

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

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

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

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

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

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

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

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

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

Additional comments not posted (8)
x/quarantine/spec/04_events.md (4)

17-19: The escaping of curly braces in the attribute values is correctly implemented.

27-29: The escaping of curly braces in the attribute values is correctly implemented.

38-41: The escaping of curly braces in the attribute values is correctly implemented.

49-52: The escaping of curly braces in the attribute values is correctly implemented.

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

18-20: The escaping of curly braces in the attribute values is correctly implemented.

28-30: The escaping of curly braces in the attribute values is correctly implemented.

38-40: The escaping of curly braces in the attribute values is correctly implemented.

48-50: The escaping of curly braces in the attribute values is correctly implemented.

@SpicyLemon
Copy link
Contributor

Looks like there's an unsigned commit: ad2c5e4 @webbushka Merge branch 'aj/docs-escape-brackets' of github.com:provenance-io/provenance into aj/docs-escape-brackets

@SpicyLemon
Copy link
Contributor

superseded by #2007

@SpicyLemon SpicyLemon closed this May 28, 2024
auto-merge was automatically disabled May 28, 2024 19:03

Pull request was closed

@SpicyLemon SpicyLemon deleted the aj/docs-escape-brackets branch December 4, 2024 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@SpicyLemon SpicyLemon SpicyLemon approved these changes

@Taztingo Taztingo Taztingo approved these changes

@scirner22 scirner22 scirner22 left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@webbushka @SpicyLemon @scirner22 @Taztingo @iramiller