Skip to content

chore(docs): fix escape in README.md #560

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
Merged
aaguiarz merged 2 commits into from
Aug 13, 2025
Merged

chore(docs): fix escape in README.md #560

aaguiarz merged 2 commits into from
Aug 13, 2025

Conversation

@aaguiarz
Copy link
Member

@aaguiarz aaguiarz commented Aug 13, 2025 •
edited by coderabbitai bot
Loading

Improvements in Glob support docs

Description

What problem is being solved?

How is it being solved?

What changes are made to solve it?

References

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

Summary by CodeRabbit

  • Documentation
    • Clarified glob patterns for the --tests option, showing quoted patterns.
    • Updated examples to include recursive matching (e.g., "**/.fga.yaml") alongside "tests/.fga.yaml".
    • Standardized quoting of glob patterns across related parameter descriptions for consistency.
    • No functional changes; documentation only.

@aaguiarz
Update README.md
9ee8436 
Improvements in Glob support docs
@aaguiarz aaguiarz requested review from a team as code owners August 13, 2025 15:40
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 13, 2025 •
edited
Loading

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Updated README.md documentation to show quoted glob patterns for the --tests option, expanding examples to include recursive pattern "**/*.fga.yaml" and standardizing quoting across related parameter descriptions. No code or API changes.

Changes

Cohort / File(s) Summary of changes
Documentation: tests glob patterns
README.md		 Updated --tests examples to use quoted glob patterns; added recursive "**/*.fga.yaml"; standardized quoted patterns across related sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/cli-glob-support

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • 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.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

@rhamzeh rhamzeh changed the title Update README.md chore(docs): fix escape in README.md Aug 13, 2025
coderabbitai[bot]
coderabbitai bot reviewed Aug 13, 2025
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

🧹 Nitpick comments (1)
README.md (1)

544-544: Align list style with markdownlint (MD004) and clarify quoting guidance

Switch to dash list style to satisfy MD004, and add a concise note encouraging quoting to avoid shell glob expansion. Also standardize “YAML” capitalization.

-* `--tests`: Name of the tests file, or a glob pattern to multiple files (for example `"tests/*.fga.yaml"`,  or `"**/*.fga.yaml"`). Each file must be in yaml format.  See [Store File Format](docs/STORE_FILE.md) for detailed documentation.
+- `--tests`: Name of the tests file, or a glob pattern matching multiple files (for example "tests/*.fga.yaml" or "**/*.fga.yaml"). Quote the pattern to prevent your shell from expanding it. Each file must be in YAML format. See [Store File Format](docs/STORE_FILE.md) for detailed documentation.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a6f1959 and 9ee8436.

📒 Files selected for processing (1)
  • README.md (2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

544-544: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)

rhamzeh
rhamzeh requested changes Aug 13, 2025
View reviewed changes
@aaguiarz @rhamzeh
Update README.md
ca12aef 
Co-authored-by: Raghd Hamzeh <raghd@rhamzeh.com>
@rhamzeh rhamzeh added this pull request to the merge queue Aug 13, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Aug 13, 2025
@aaguiarz aaguiarz added this pull request to the merge queue Aug 13, 2025
Merged via the queue into main with commit 02a1245 Aug 13, 2025
22 checks passed
@aaguiarz aaguiarz deleted the chore/cli-glob-support branch August 13, 2025 16:19
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

@rhamzeh rhamzeh rhamzeh approved these changes

@dyeam0 dyeam0 dyeam0 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@aaguiarz @rhamzeh @dyeam0