Skip to content

docs(cli): Remove broken ref bold markup#4204

Merged
johanneskoester merged 1 commit into
snakemake:mainfrom
TRON-Bioinformatics:fix-minor-profile-docs-formatting
May 29, 2026
Merged

docs(cli): Remove broken ref bold markup#4204
johanneskoester merged 1 commit into
snakemake:mainfrom
TRON-Bioinformatics:fix-minor-profile-docs-formatting

Conversation

@jonasfreimuth

@jonasfreimuth jonasfreimuth commented May 26, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Nested markup is not allowed, see
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#gotchas.

QC

  • The PR contains a test case for the changes or the changes are already covered by an existing test case. -> Pure docs change.
  • The documentation (docs/) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake). -> Pure docs change.
  • I, as a human being, have checked each line of code in this pull request

AI-assistance disclosure

I used AI assistance for:

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Summary by CodeRabbit

  • Documentation
    • Improved formatting of the "Profiles" section in CLI documentation for clearer presentation of supported profile types.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 26, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6c138849-f3b9-4599-9865-4642384d5aeb

📥 Commits

Reviewing files that changed from the base of the PR and between 6108712 and 783f04f.

📒 Files selected for processing (1)
  • docs/executing/cli.rst
📝 Walkthrough

Walkthrough

This PR makes a minimal documentation formatting update to the CLI documentation. The "Profiles" section is reorganized to present the two supported profile types as a cleaner numbered list by removing bold emphasis from a cross-reference and adjusting whitespace for improved readability.

Changes

Documentation Update

Layer / File(s) Summary
Profiles section formatting
docs/executing/cli.rst		 The numbered list under "Profiles" removes bold emphasis from the :ref:\global-profiles`` entry and adjusts whitespace/line breaks to render as a cleaner two-item list.

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: removing broken ref bold markup from CLI documentation.
Description check ✅ Passed The description covers all required template sections with appropriate detail for a pure documentation fix, including clear rationale and completed QC checklist.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@johanneskoester johanneskoester merged commit 1200ebf into snakemake:main May 29, 2026
60 checks passed
@snakemake-bot snakemake-bot mentioned this pull request May 22, 2026
Merged
johanneskoester pushed a commit that referenced this pull request May 29, 2026
@snakemake-bot
chore(main): release 9.21.1 (#4200)
5b5482e 
🤖 I have created a release *beep* *boop*
---


##
[9.21.1](v9.21.0...v9.21.1)
(2026-05-29)


### Bug Fixes

* add default json function to benchmarks
([#4128](#4128))
([41fab22](41fab22))
* do not rerun when checkpoint job missing but downstream file exists
([#4124](#4124))
([a060b93](a060b93))
* ensure that error logs contain all available details
([#4183](#4183))
([74a86e9](74a86e9))
* handle missing pss attribute in benchmark on Windows
([#4160](#4160))
([da52080](da52080))
* implement Resources.setdefault
([#3968](#3968))
([2413e99](2413e99))
* reporting remote nodes number
([#3978](#3978))
([8c534f0](8c534f0))
* resolve pathvars before constructing storage queries
([#3969](#3969))
([bd15237](bd15237))
* storage temp() file cleanup with RemoteProvider
([#4189](#4189))
([898bad1](898bad1))
* tolerate FileNotFoundError in drop_iocache
([#4153](#4153))
([#4191](#4191))
([ce26b28](ce26b28))


### Documentation

* Added guide on debugging workflows
([#4029](#4029))
([3d052ae](3d052ae))
* **cli:** Remove broken ref bold markup
([#4204](#4204))
([1200ebf](1200ebf))
* remove duplicated resources attribute in rules.rst
([#4190](#4190))
([6c8ecdd](6c8ecdd))
* **rules:** Update script type hint advice
([#4193](#4193))
([6108712](6108712))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

2 participants

@jonasfreimuth @johanneskoester