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

fix: allow empty command descriptions #1092

Merged
merged 1 commit into from
Jan 20, 2024
Merged

fix: allow empty command descriptions #1092

merged 1 commit into from
Jan 20, 2024

Conversation

DaniPopes
Copy link
Member

@DaniPopes DaniPopes merged commit f099d18 into foundry-rs:master Jan 20, 2024
1 check passed
@DaniPopes DaniPopes deleted the fix-empty-description branch January 20, 2024 11:06
@cdump
Copy link
Contributor

cdump commented Jan 20, 2024

Maybe it would be better if we enforced writing command descriptions?
All existing commands have descriptions, and I believe it's beneficial for documentation.

@DaniPopes
Copy link
Member Author

Sure, at the review level in Foundry or maybe with #![warn(missing_docs)], not in an external repo.

@cdump
Copy link
Contributor

cdump commented Jan 20, 2024

Until this check is implemented and fixed at the Foundry repo level, wouldn't it be better to identify and address the issue here, in another repo? It's not an ideal solution, but probably better than 'silently ignore.'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

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

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

@onbjerg onbjerg Awaiting requested review from onbjerg onbjerg 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.
2 participants
@DaniPopes @cdump