docs: Update lookup signature by peterjc · Pull Request #3090 · snakemake/snakemake

peterjc · 2024-09-18T12:39:01Z

This does two things, first it moves the required within argument to its own line - previously it was too easily overlooked. See change in bdd732d

Second, it adds the default argument from 08e88e2 on PR #2907.

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
- Updated the documentation to clarify that the within parameter is now required for the lookup function.
- Introduced a new default value, NODEFAULT, for the default parameter, enhancing clarity on function usage.

This does two things, first it moves the required ``within`` argument to its own line - previously it was too easily overlooked. See change in bdd732d Second, it adds the ``default`` argument from 08e88e2 on PR snakemake#2907.

coderabbitai · 2024-09-18T12:39:13Z

Walkthrough

The changes involve modifications to the lookup function's signature in the documentation. The within parameter has been changed from optional to required, necessitating its provision during function calls. Additionally, a new default value, NODEFAULT, has been introduced for the default parameter, which was previously absent. The documentation has been updated accordingly to clarify these changes and the expected inputs for the within parameter.

Changes

Files	Change Summary
docs/snakefiles/rules.rst	Modified `lookup` function signature: `within` is now required; added `default=NODEFAULT`.

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 generate interesting stats about this repository and render them as a table.
-- @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.

sonarqubecloud · 2024-09-18T12:39:52Z

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 SonarCloud

coderabbitai

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e9ce4a3 and 9aa11dd.

Files selected for processing (1)

docs/snakefiles/rules.rst (1 hunks)

Additional comments not posted (1)

docs/snakefiles/rules.rst (1)

373-373: LGTM!

The new optional default parameter with default value NODEFAULT has been documented accurately. This is not a breaking change.

coderabbitai · 2024-09-18T12:42:14Z

docs/snakefiles/rules.rst

+        is_nrows: Optional[int],
+        within=None,


Update existing code calling lookup to provide the new required within parameter.

The within parameter is now required when calling lookup. It expects a Python mapping, pandas DataFrame, or pandas Series. Existing code that does not provide within will fail and needs to be updated.

The documentation update itself looks good and accurately reflects the signature change.

🤖 I have created a release *beep* *boop* --- ## [8.20.4](v8.20.3...v8.20.4) (2024-09-20) ### Bug Fixes * cache conda envs to fix performance regression introduced in #1300 ([#3093](#3093)) ([66600c4](66600c4)) * Flatten conda pip dependencies for report rule info ([#3085](#3085)) ([56a1f20](56a1f20)) * improve runtime complexity of post-job checkpoint handling ([#3096](#3096)) ([ba30781](ba30781)) ### Documentation * Clarify the lookup function docstring ([#3091](#3091)) ([94177d5](94177d5)) * Update lookup signature ([#3090](#3090)) ([655d6a1](655d6a1)) --- 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>

Update lookup signature

9aa11dd

This does two things, first it moves the required ``within`` argument to its own line - previously it was too easily overlooked. See change in bdd732d Second, it adds the ``default`` argument from 08e88e2 on PR snakemake#2907.

peterjc requested a review from johanneskoester as a code owner September 18, 2024 12:39

coderabbitai bot reviewed Sep 18, 2024

View reviewed changes

johanneskoester approved these changes Sep 19, 2024

View reviewed changes

johanneskoester merged commit 655d6a1 into snakemake:main Sep 19, 2024

github-actions bot mentioned this pull request Sep 19, 2024

chore(main): release 8.20.4 #3094

Merged

peterjc deleted the patch-2 branch September 19, 2024 14:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Update lookup signature#3090

docs: Update lookup signature#3090
johanneskoester merged 1 commit intosnakemake:mainfrom
peterjc:patch-2

peterjc commented Sep 18, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Sep 18, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

sonarqubecloud bot commented Sep 18, 2024

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Sep 18, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

peterjc commented Sep 18, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

QC

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Sep 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

sonarqubecloud bot commented Sep 18, 2024

Quality Gate passed

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Sep 18, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

peterjc commented Sep 18, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 18, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)