Fix markdownlint violations in users guide

[leynos]

Summary

• add explicit languages to fenced code blocks in the user guide
• wrap long comments and inline text to satisfy the 80-column markdown rule
• tidy macro example formatting to meet markdownlint expectations

Testing

• make markdownlint

---

https://chatgpt.com/codex/tasks/task_e_690495c3499483228a8cb4c79e613800

Summary by Sourcery

Fix markdownlint violations in the user guide by adding explicit language tags to fenced code blocks, wrapping lines to satisfy the 80-column rule, and refining example formatting for lint compliance.

Documentation:

• Add explicit language identifiers to fenced code blocks in the user guide
• Wrap long comments and inline text to comply with the 80-column markdownlint rule
• Refine macro and example formatting to satisfy markdownlint expectations

[sourcery-ai]

Reviewer's Guide

This PR resolves markdownlint issues in the users guide by adding explicit language identifiers to fenced code blocks, rewrapping long comments and inline text to adhere to the 80-column rule, and refining formatting in YAML examples and macros for consistency.

File-Level Changes

Change	Details	Files
Add explicit language tags to fenced code blocks	Prefixed shell command blocks with sh</li><li>Prefixed manifest and config examples with yaml Prefixed CLI usage snippet with ```text	docs/users-guide.md
Wrap long comments and inline text to satisfy 80-column rule	Split lengthy in-line comments in rule and target definitions Reflowed control structures and filters descriptions into multiple lines Wrapped Accepts list for timedelta filter to fit column limit	docs/users-guide.md
Clean up YAML example formatting and macro definitions	Adjusted indentation and comment placement in targets and deps sections Standardized macro signature/body indentation Removed extra spaces around pipe operators in shell_escape filters	docs/users-guide.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes - here's some feedback:

• Consider using 'bash' or 'sh' instead of 'text' for the final CLI example block to keep syntax highlighting consistent.
• Please preview the updated markdown in HTML to ensure line wraps and macro formatting didn’t introduce any rendering issues.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- Consider using 'bash' or 'sh' instead of 'text' for the final CLI example block to keep syntax highlighting consistent.
- Please preview the updated markdown in HTML to ensure line wraps and macro formatting didn’t introduce any rendering issues.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[coderabbitai]

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 2 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between e6fdbd8 and b31bcea.

📒 Files selected for processing (1)

• docs/users-guide.md (10 hunks)

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch codex/run-markdownlint-and-fix-violations

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}