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

Remove {n} support #3230

Open
epage opened this issue Dec 30, 2021 · 0 comments
Open

Remove {n} support #3230

epage opened this issue Dec 30, 2021 · 0 comments
Labels
A-help Area: documentation, including docs.rs, readme, examples, etc... C-bug Category: Updating dependencies M-breaking-change Meta: Implementing or merging this will introduce a breaking change. S-blocked Status: Blocked on something else such as an RFC or other implementation work.
Milestone
5.0

Comments

@epage
Copy link
Member

epage commented Dec 30, 2021

Maintainer's notes

We previously removed {n} support in #1810 but found there wasn't a way to force a hard break without using verbatim_doc_comment which has downsides (#3198). #2389 should address this but we don't want to block clap's development.

When we remove {n} support again, we should add asserts for it to help users catch the breaking change, like we did in 61c9e62.
@epage epage added C-bug Category: Updating dependencies M-breaking-change Meta: Implementing or merging this will introduce a breaking change. A-help Area: documentation, including docs.rs, readme, examples, etc... S-blocked Status: Blocked on something else such as an RFC or other implementation work. labels Dec 30, 2021
@epage epage added this to the 4.0 milestone Dec 30, 2021
epage added a commit to epage/clap that referenced this issue Dec 30, 2021
@epage
Revert "Remove {n} support"
e5fbdc9 
This reverts commit 333b993.

PR clap-rs#1810's motivation was effectively "this is redundant with `\n`".
That is a fine motivation.  Unfortunately, we don't have a way to force
a hard break in `clap_derive`.  clap-rs#2389 should help with this eventually
but we shouldn't hold up 3.0 to get that ready.  So in the mean time, we
are restoring `{n}`.

We have clap-rs#3230 for tracking the re-removal of it.
@epage epage mentioned this issue Dec 30, 2021
Merged
@epage epage modified the milestones: 4.0, 5.0 Jun 1, 2022
@epage epage mentioned this issue Dec 15, 2022
Closed
@epage epage mentioned this issue Nov 6, 2023
Open
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-help Area: documentation, including docs.rs, readme, examples, etc... C-bug Category: Updating dependencies M-breaking-change Meta: Implementing or merging this will introduce a breaking change. S-blocked Status: Blocked on something else such as an RFC or other implementation work.
Projects
None yet
Milestone
5.0
Development

No branches or pull requests
1 participant
@epage