Skip to content

Conversation

@gaurav
Copy link
Contributor

@gaurav gaurav commented Nov 21, 2025

In https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor/slurm.html#setting-up-a-global-profile, there is a sentence that isn't formatted correctly:

==This is ongoing development. Eventually, you will be able to annotate different file access patterns.==

This PR changes that into a blockquote, which looks better:

This is ongoing development. Eventually, you will be able to annotate different file access patterns.==

Summary by CodeRabbit

  • Documentation
    • Updated formatting of development status notes in the documentation for improved visual presentation and consistency.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 21, 2025

Walkthrough

Replaces centered note block formatting with markdown blockquote formatting in docs/further.md at two locations. The note regarding ongoing development for file access pattern annotation is reformatted for consistency. No functional logic or content modifications are made.

Changes

Cohort / File(s) Change Summary
Documentation Formatting
docs/further.md
Converts centered note blocks (using ==...== syntax) to markdown blockquote format (>...) at two instances, maintaining identical content while standardizing presentation style

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Purely cosmetic/formatting changes with no content alterations
  • No logic, validation, or structural modifications
  • Changes are identical and repetitive across two locations

Poem

🐰 A note once centered, boxed with care,
Now blockquotes frame it, light and fair!
Two spots refreshed with markdown grace,
Consistency blooms in this humble place. ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title accurately describes the main change: replacing incorrect Markdown syntax (== markers) with a blockquote format in documentation.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


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

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

@gaurav gaurav changed the title Replace incorrect Markdown with a blockquote fix: Replace incorrect Markdown with a blockquote Nov 21, 2025
@gaurav gaurav marked this pull request as ready for review November 22, 2025 22:39
@cmeesters cmeesters changed the title fix: Replace incorrect Markdown with a blockquote docs: Replace incorrect Markdown with a blockquote Nov 24, 2025
@cmeesters cmeesters self-requested a review November 24, 2025 09:42
Copy link
Member

@cmeesters cmeesters left a comment

Choose a reason for hiding this comment

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

trivial - no code change

@cmeesters
Copy link
Member

@gaurav thanks for spotting this. I approved it (of course), albeit changing 'fix' to 'docs' as a subject.

@cmeesters cmeesters merged commit b45709f into snakemake:main Nov 24, 2025
8 of 9 checks passed
@gaurav gaurav deleted the fix-incorrect-markdown branch November 24, 2025 21:33
cmeesters pushed a commit that referenced this pull request Nov 25, 2025
🤖 I have created a release *beep* *boop*
---


##
[2.0.0](v1.9.2...v2.0.0)
(2025-11-24)


### ⚠ BREAKING CHANGES

* proposal for dynamic partition selection
([#321](#321))

### Features

* partition time handling
([#378](#378))
([53be508](53be508))
* proposal for dynamic partition selection
([#321](#321))
([95821f9](95821f9))


### Bug Fixes

* naming SLURM logs, SLURM logs not just "log files"
([#372](#372))
([ce7cc4b](ce7cc4b))


### Documentation

* Replace incorrect Markdown with a blockquote
([#377](#377))
([b45709f](b45709f))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **BREAKING CHANGES**
  * Version 2.0.0 introduces breaking changes
* **New Features**
  * Dynamic partition selection functionality
* **Bug Fixes**
  * Multiple bug fixes included
* **Documentation**
  * Updated documentation for version 2.0.0

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants