Fix stale retail/healthcare recipe references and placeholder package metadata - #15
Open
Anilreddy2309 wants to merge 1 commit into
Open
Fix stale retail/healthcare recipe references and placeholder package metadata#15Anilreddy2309 wants to merge 1 commit into
Anilreddy2309 wants to merge 1 commit into
Conversation
… metadata
Two doc/metadata drift issues found while reviewing the codebase:
1. nvflow/cli/main.py's --recipe help text and nvflow/core/stage_registry.py's
register()/class docstrings referenced "retail" and "healthcare" as
example recipes. Only finance, example, and multimodal recipes exist
anywhere in the codebase -- retail/healthcare appear to be leftover
placeholder names from before the repo's public release. Updated the
examples to reference real recipes.
2. pyproject.toml shipped an unfilled template placeholder
(authors = [{name = "Your Team", email = "team@example.com"}]) in the
public release. Replaced with "NVIDIA Corporation" -- happy to adjust
to a specific team alias/email if maintainers prefer one.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Signed-off-by: Anil Balireddy <anilbalireddi@gmail.com>
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.
Summary
Two small doc/metadata drift issues found while reviewing the codebase:
Non-existent example recipes in docs/help text.
nvflow/cli/main.py's--recipeoption help text andnvflow/core/stage_registry.py'sregister()/class docstrings referenceretailandhealthcareas example recipes. Onlyfinance,example, andmultimodalrecipes exist anywhere in the codebase (confirmed via@StageRegistry.registercall sites) —retail/healthcarelook like leftover placeholder names from before the repo's public release. Updated the examples to real recipe names.Placeholder package metadata.
pyproject.tomlshippedauthors = [{name = "Your Team", email = "team@example.com"}]— an unfilled template placeholder in the public release. Replaced with"NVIDIA Corporation". Happy to adjust to a specific team alias/email if maintainers prefer one — I didn't want to guess at an internal contact.Test plan
ruff check/ruff format --checkpasspyproject.tomlstill parses as valid TOML after the editpytest tests/suite passes (339 passed, 3 pre-existing skips) — no code behavior changed🤖 Generated with Claude Code