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

Use 'if and only if' wording #60

Open
andsens opened this issue Dec 30, 2012 · 4 comments
Open

Use 'if and only if' wording #60

andsens opened this issue Dec 30, 2012 · 4 comments
Labels
debate choice that involves preference documentation human-oriented text could be improved

Comments

@andsens
Copy link

andsens commented Dec 30, 2012

I noticed that you may be able to express some of the spec in a more precise way by borrowing wording from the field of logics.

This section MUST NOT be rendered unless the data list is empty.

This sentence has a double negation which can make it a bit confusing.
You can use the following wording instead and make the coupling crystal clear:

This section MUST be rendered if and only if the data list is empty.

@jgonggrijp jgonggrijp added documentation human-oriented text could be improved debate choice that involves preference labels Nov 9, 2023
@jgonggrijp
Copy link
Member

I'm not convinced that the second wording is better. It is true that double negations are not great, but I suspect fewer people are familiar with "if and only if" than with "not unless".

@andsens
Copy link
Author

andsens commented Nov 9, 2023

Oh wow, blast from the past 🤣
I don't have any skin in the game any longer, but I'm still a staunch opponent of double negations. Additionally the bijection (i.e. if the section is rendered -> the data list is empty, and if the data list is empty -> the section is rendered) is not represented in the original. The reason I noticed it was because I reverse parsed the rendered templates in my master thesis project, where that detail was rather important :-)
May I suggest the following instead?

This section MUST be rendered only when the data list is empty.

It's the same as "if and only if", but it's more colloquial.

Anyways, closing. It's such a minor thing. I'm sure you have more important things to do, and I hardly believe that it will ever make a difference for someone.

@andsens andsens closed this as completed Nov 9, 2023
@jgonggrijp
Copy link
Member

"Not unless" means the same thing as "if and only if". "Unless" by itself is exclusive or, so the negation of it is biimplication. "Only when" does not mean the same thing; it is a reverse implication only (it misses the first part of "if and only if").

All that being said, and despite the age of the issue, you still have a point regarding the double negation. I will reopen this for the time being, in case other people want to share their opinion on it.

@jgonggrijp jgonggrijp reopened this Nov 9, 2023
@bobthecow
Copy link
Member

"MUST NOT unless" means "MAY if". we should change it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
debate choice that involves preference documentation human-oriented text could be improved
Projects
None yet
Development

No branches or pull requests

3 participants