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.

Sign up for GitHub

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

Jump to bottom

docs(framework) Change description for invalid project name #4396

Merged
merged 3 commits into from
Oct 30, 2024
Merged

docs(framework) Change description for invalid project name #4396

merged 3 commits into from
Oct 30, 2024

Conversation

WilliamLindskog
Copy link
Contributor

Issue

Throws inaccurate error saying that valid project name can include underscores. This is wrong.

Description

Change is small in cli.

Related issues/PRs

N/A

Proposal

Change text to say that valid project name includes hyphens and not underscores.

Explanation

To prevent confusion.

Checklist

  • [ x] Implement proposed change
  • [ x] Write tests
  • [ x] Update documentation
  • [ x] Make CI checks pass
  • [ x] Ping maintainers on Slack (channel #contributions)

Any other comments?

charlesbvll
charlesbvll reviewed Oct 30, 2024
View reviewed changes
Copy link
Member

@charlesbvll charlesbvll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!

src/py/flwr/cli/build.py Outdated Show resolved Hide resolved
@danieljanes @charlesbvll
Update src/py/flwr/cli/build.py
656ffcf 
Co-authored-by: Charles Beauville <charles@flower.ai>
@danieljanes danieljanes enabled auto-merge (squash) October 30, 2024 08:05
@danieljanes danieljanes merged commit d6e6cac into main Oct 30, 2024
53 checks passed
@danieljanes danieljanes deleted the underscore branch October 30, 2024 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@charlesbvll charlesbvll charlesbvll left review comments

@danieljanes danieljanes danieljanes approved these changes

@tanertopal tanertopal Awaiting requested review from tanertopal tanertopal is a code owner

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
@WilliamLindskog @danieljanes @charlesbvll