Rename child-manifests to sub-manifests#1027
Merged
Conversation
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (10)
WalkthroughSystematic rename of "child-manifests" to "sub-manifests" across code, docs, tests, and feature files. Public symbols renamed (e.g., Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
dfetch/manifest/parse.py (1)
100-100: Minor: Use singular form in log message.The log message refers to a single path but uses the plural form "sub-manifests".
Proposed fix
- logger.debug(f"Found sub-manifests {path}") + logger.debug(f"Found sub-manifest {path}")🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@dfetch/manifest/parse.py` at line 100, Change the log message string used in the logger.debug call that currently reads "Found sub-manifests {path}" to the singular form "Found sub-manifest {path}" (the call using logger.debug and the variable path in parse.py); update the message text only so it correctly reflects a single path.dfetch/commands/common.py (1)
25-27: Use a precomputedsetfor remote URL membership checks.Line 25 rebuilds a list on every
subprojectiteration and reusesprojectas the inner variable name, which hurts readability and scales poorly.♻️ Suggested refactor
def check_sub_manifests(manifest: Manifest, project: ProjectEntry) -> None: @@ - for submanifest in get_submanifests(skip=[manifest.path]): + manifest_remote_urls = { + parent_project.remote_url for parent_project in manifest.projects + } + for submanifest in get_submanifests(skip=[manifest.path]): recommendations: list[ProjectEntry] = [] for subproject in submanifest.projects: - if subproject.remote_url not in [ - project.remote_url for project in manifest.projects - ]: + if subproject.remote_url not in manifest_remote_urls: recommendations.append(subproject.as_recommendation())🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@dfetch/commands/common.py` around lines 25 - 27, Precompute a set of existing remote URLs before iterating subproject to avoid rebuilding the list and inner-variable shadowing; e.g., create a set from manifest.projects' remote_url values (use a name like existing_remote_urls) and then replace the condition "if subproject.remote_url not in [project.remote_url for project in manifest.projects]" with a membership check against that set (if subproject.remote_url not in existing_remote_urls), ensuring you remove the inner "project" list comprehension to improve readability and performance.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CHANGELOG.rst`:
- Line 5: Replace the placeholder issue reference "(`#0`)" with the correct PR
number "(`#1027`)" in the CHANGELOG.rst entry that renames "child-manifests" to
"sub-manifests" so the changelog reads "* Rename child-manifests to
sub-manifests in documentation and code (`#1027`)"; update only the issue number
token in that line.
---
Nitpick comments:
In `@dfetch/commands/common.py`:
- Around line 25-27: Precompute a set of existing remote URLs before iterating
subproject to avoid rebuilding the list and inner-variable shadowing; e.g.,
create a set from manifest.projects' remote_url values (use a name like
existing_remote_urls) and then replace the condition "if subproject.remote_url
not in [project.remote_url for project in manifest.projects]" with a membership
check against that set (if subproject.remote_url not in existing_remote_urls),
ensuring you remove the inner "project" list comprehension to improve
readability and performance.
In `@dfetch/manifest/parse.py`:
- Line 100: Change the log message string used in the logger.debug call that
currently reads "Found sub-manifests {path}" to the singular form "Found
sub-manifest {path}" (the call using logger.debug and the variable path in
parse.py); update the message text only so it correctly reflects a single path.
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
CHANGELOG.rstdfetch/commands/check.pydfetch/commands/common.pydfetch/commands/update.pydfetch/manifest/parse.pydoc/internal.rstfeatures/updated-project-has-dependencies.featuretests/test_check.pytests/test_manifest.pytests/test_update.py
spoorcc
force-pushed
the
rename-child-to-sub
branch
from
6d8d564 to
3b1eff9
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rename child-manifest to sub-manifest to make concepts less confusing.
Summary by CodeRabbit