Skip to content

docs: Fix typo (seesee to see)#3037

Merged
johanneskoester merged 1 commit intosnakemake:mainfrom
peterjc:patch-1
Aug 27, 2024
Merged

docs: Fix typo (seesee to see)#3037
johanneskoester merged 1 commit intosnakemake:mainfrom
peterjc:patch-1

Conversation

@peterjc
Copy link
Copy Markdown
Contributor

@peterjc peterjc commented Aug 21, 2024 •
edited by coderabbitai bot
Loading

QC

  • The PR contains a test case for the changes or the changes are already covered by an existing test case.
  • 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).

Summary by CodeRabbit

  • Documentation
    • Corrected a typographical error in the Snakemake rules documentation for improved clarity on shell command invocation.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Aug 21, 2024 •
edited
Loading

Walkthrough

The recent update provides a minor correction in the Snakemake documentation, specifically rectifying a typographical error for clarity. This enhancement improves the accuracy of information regarding shell command usage without affecting the functionality or logic of the codebase. Users will benefit from a clearer understanding of the default behavior of shell commands in Snakemake.

Changes

Files Change Summary
docs/snakefiles/rules.rst Corrected typographical error from "seesee" to "see" in documentation.

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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

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 Aug 21, 2024
View reviewed changes
Copy link
Copy Markdown
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 9a60046 and 7785131.

Files selected for processing (1)
  • docs/snakefiles/rules.rst (1 hunks)
Files skipped from review due to trivial changes (1)
  • docs/snakefiles/rules.rst

@peterjc peterjc changed the title Fix typo (seesee to see) docs: Fix typo (seesee to see) Aug 21, 2024
@johanneskoester johanneskoester merged commit de201fb into snakemake:main Aug 27, 2024
@github-actions github-actions bot mentioned this pull request Aug 27, 2024
Merged
johanneskoester pushed a commit that referenced this pull request Aug 29, 2024
@github-actions
chore(main): release 8.19.0 (#3051)
f955478 
🤖 I have created a release *beep* *boop*
---


##
[8.19.0](v8.18.2...v8.19.0)
(2024-08-29)


### Features

* check consistency of output file mtimes (must be newer than input
files) ([#3050](#3050))
([666cf62](666cf62))
* print host name when executing workflow
([#3048](#3048))
([b0ff787](b0ff787))


### Bug Fixes

* `mem` and `disk` inference fixes
([#3040](#3040))
([7530794](7530794))
* avoid error accessing superclass in ioutils
([#3056](#3056))
([a66a5f5](a66a5f5))
* disable execute after print compilation
([#3041](#3041))
([86ed3cd](86ed3cd))
* download report assets upon package build such that reports become
possible offline (cont. of
[#2904](#2904))
([#3026](#3026))
([e8dad4b](e8dad4b))


### Documentation

* Add 'Editor integrations' section to Installation page
([#3045](#3045))
([9a4006d](9a4006d))
* Fix typo (seesee to see)
([#3037](#3037))
([de201fb](de201fb))
* various documentation fixes
([#3052](#3052))
([b11460c](b11460c))

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

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
vandalt pushed a commit to vandalt/snakemake that referenced this pull request Aug 29, 2024
@peterjc @vandalt
docs: Fix typo (seesee to see) (snakemake#3037)
fe77076 
<!--Add a description of your PR here-->

### QC
<!-- Make sure that you can tick the boxes below. -->

* [ ] The PR contains a test case for the changes or the changes are
already covered by an existing test case.
* [x] 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).


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

## Summary by CodeRabbit

- **Documentation**
- Corrected a typographical error in the Snakemake rules documentation
for improved clarity on shell command invocation.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
vandalt pushed a commit to vandalt/snakemake that referenced this pull request Aug 29, 2024
@github-actions @vandalt
chore(main): release 8.19.0 (snakemake#3051)
787025a 
🤖 I have created a release *beep* *boop*
---


##
[8.19.0](snakemake/snakemake@v8.18.2...v8.19.0)
(2024-08-29)


### Features

* check consistency of output file mtimes (must be newer than input
files) ([snakemake#3050](snakemake#3050))
([666cf62](snakemake@666cf62))
* print host name when executing workflow
([snakemake#3048](snakemake#3048))
([b0ff787](snakemake@b0ff787))


### Bug Fixes

* `mem` and `disk` inference fixes
([snakemake#3040](snakemake#3040))
([7530794](snakemake@7530794))
* avoid error accessing superclass in ioutils
([snakemake#3056](snakemake#3056))
([a66a5f5](snakemake@a66a5f5))
* disable execute after print compilation
([snakemake#3041](snakemake#3041))
([86ed3cd](snakemake@86ed3cd))
* download report assets upon package build such that reports become
possible offline (cont. of
[snakemake#2904](snakemake#2904))
([snakemake#3026](snakemake#3026))
([e8dad4b](snakemake@e8dad4b))


### Documentation

* Add 'Editor integrations' section to Installation page
([snakemake#3045](snakemake#3045))
([9a4006d](snakemake@9a4006d))
* Fix typo (seesee to see)
([snakemake#3037](snakemake#3037))
([de201fb](snakemake@de201fb))
* various documentation fixes
([snakemake#3052](snakemake#3052))
([b11460c](snakemake@b11460c))

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

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@coderabbitai coderabbitai bot mentioned this pull request Mar 11, 2025
Merged
2 tasks
@coderabbitai coderabbitai bot mentioned this pull request May 17, 2025
Merged
2 tasks
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

@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

@peterjc @johanneskoester