Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove hardcoded ref to docs #3068

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

ppiegaze
Copy link
Member

@ppiegaze ppiegaze commented Jan 17, 2025

Tracking issue

Why are the changes needed?

On pyflyte init and union init the message reporting success includes a hardcoded reference to a page in the Flyte docs.
The location of this page could easily change, and for union the reference is entirely incorrect.

It is better to simply remove the URL completely. It adds very little utility.

What changes were proposed in this pull request?

Change to text displayed on CLI command success

Summary by Bito

Modified and simplified Flyte CLI success message for project initialization commands by removing hardcoded documentation URL. The change streamlines the success message to only show project directory name, enhancing maintainability and preventing potential issues with broken documentation links.

Unit tests added: False

Estimated effort to review (1-5, lower is better): 1

Signed-off-by: Peeter Piegaze <[email protected]>
@flyte-bot
Copy link
Contributor

flyte-bot commented Jan 17, 2025

Code Review Agent Run #2c5238

Actionable Suggestions - 0
Review Details
  • Files reviewed - 1 · Commit Range: 055d626..055d626
    • flytekit/clis/sdk_in_container/init.py
  • Files skipped - 0
  • Tools
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful
    • MyPy (Static Code Analysis) - ✔︎ Successful
    • Astral Ruff (Static Code Analysis) - ✔︎ Successful

AI Code Review powered by Bito Logo

@flyte-bot
Copy link
Contributor

flyte-bot commented Jan 17, 2025

Changelist by Bito

This pull request implements the following key changes.

Key Change Files Impacted
Feature Improvement - CLI Message Enhancement

init.py - Simplified project initialization success message by removing hardcoded documentation URL

thomasjpfan
thomasjpfan previously approved these changes Jan 18, 2025
Signed-off-by: Kevin Su <[email protected]>
@flyte-bot
Copy link
Contributor

flyte-bot commented Jan 25, 2025

Code Review Agent Run #c8672a

Actionable Suggestions - 0
Review Details
  • Files reviewed - 1 · Commit Range: 055d626..afd08ff
    • flytekit/clis/sdk_in_container/init.py
  • Files skipped - 0
  • Tools
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful
    • MyPy (Static Code Analysis) - ✔︎ Successful
    • Astral Ruff (Static Code Analysis) - ✔︎ Successful

AI Code Review powered by Bito Logo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants