Skip to content

docs: use "dictionary" not "array" wording in config docs#3156

Merged
johanneskoester merged 3 commits intosnakemake:mainfrom
ressy:docs-config-fix-wording
Nov 12, 2024
Merged

docs: use "dictionary" not "array" wording in config docs#3156
johanneskoester merged 3 commits intosnakemake:mainfrom
ressy:docs-config-fix-wording

Conversation

@ressy
Copy link
Copy Markdown
Contributor

@ressy ressy commented Oct 18, 2024 •
edited by coderabbitai bot
Loading

This change would just replace "array" with "dictionary" in this bit of the documentation on configuration:

If the configfile statement is not used, the config variable provides an empty array.

(What's an array?)

Summary by CodeRabbit

  • Documentation
    • Updated documentation to clarify the behavior of the config variable when no configuration file is specified, highlighting that it provides an empty dictionary instead of an empty array.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Oct 18, 2024 •
edited
Loading

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • CHANGELOG.md is excluded by !CHANGELOG.md

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

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

📝 Walkthrough
📝 Walkthrough

Walkthrough

The documentation for Snakemake's configuration has been updated to clarify the behavior of the config variable when no configuration file is specified. It now states that if the configfile statement is not used, the config variable provides an empty dictionary instead of an empty array. This update enhances the understanding of how configuration parameters are accessed through the config variable, while maintaining the overall structure and content of the documentation.

Changes

File Change Summary
docs/snakefiles/configuration.rst Updated documentation to clarify that config variable provides an empty dictionary when no config file is specified.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Snakemake
    participant Config

    User->>Snakemake: Run workflow without configfile
    Snakemake->>Config: Initialize config variable
    Config-->>Snakemake: Return empty dictionary
    Snakemake-->>User: Execute workflow with empty config
Loading

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>, please review it.
    • 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 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 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 using 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.

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

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.

@ressy
Copy link
Copy Markdown
Contributor Author

ressy commented Oct 19, 2024

I had no idea what onslaught of Rube Goldberg-style automation I was going to unleash by proposing a one-word change here

@fgvieira fgvieira changed the title Use "dictionary" not "array" wording in config docs docs: use "dictionary" not "array" wording in config docs Nov 12, 2024
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Nov 12, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@johanneskoester
Copy link
Copy Markdown
Contributor

johanneskoester commented Nov 12, 2024

Rube Goldberg-style

First of all, thanks a lot for your PR! Sorry that the automatic comments bothered you. It is our try to keep simplistic review tasks away from the maintainers (typos, obvious logic errors, etc.). It actually works suprisingly well in many cases. But indeed, it is of course overkill for such trivial changes. So far at least, there is no way to disable the service for certain classes of PRs, sorry.

@johanneskoester johanneskoester merged commit 17aed41 into snakemake:main Nov 12, 2024
@github-actions github-actions bot mentioned this pull request Nov 12, 2024
Merged
@ressy
Copy link
Copy Markdown
Contributor Author

ressy commented Nov 12, 2024

I'm just being snarky... with 96 open pull requests just at this moment I see why you want some automation. Thanks for merging!

@ressy ressy deleted the docs-config-fix-wording branch November 12, 2024 12:37
johanneskoester pushed a commit that referenced this pull request Nov 27, 2024
@github-actions
chore(main): release 8.25.4 (#3201)
dea213d 
🤖 I have created a release *beep* *boop*
---


##
[8.25.4](v8.25.3...v8.25.4)
(2024-11-27)


### Bug Fixes

* clean env vars in apptainer
([#3199](#3199))
([76d5329](76d5329))
* ensure that intermediate files in job groups do not cause spurious
mtime errors when checking for consistency with output files
([#3220](#3220))
([4ba2bdf](4ba2bdf))
* Remove incomplete marker also when drop-metadata is active
([#3215](#3215))
([a4f2e5c](a4f2e5c))
* Remove incomplete marker for job finished only after metadata is
written ([#3197](#3197))
([6567e5f](6567e5f))
* Support versioned URLs in Asset class and fix missing versions in
Snakemake report
([#3203](#3203))
([f086f6c](f086f6c))
* update rust-script usage to recent version (v0.35.0)
[#3183](#3183)
([#3208](#3208))
([43885d7](43885d7))


### Documentation

* clarify continuously updated input section
([#3219](#3219))
([72a6994](72a6994))
* Fix typo in CHANGELOG.md
([#3198](#3198))
([0e445ed](0e445ed))
* refer to Merkle trees instead of "blockchain" in caching.rst
([#3216](#3216))
([282e5d9](282e5d9))
* remove twitter in favor of bluesky and mastodon
([#3217](#3217))
([231c6df](231c6df))
* use "dictionary" not "array" wording in config docs
([#3156](#3156))
([17aed41](17aed41))

---
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fgvieira fgvieira fgvieira approved these changes

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

3 participants

@ressy @johanneskoester @fgvieira