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

better first lines for properties with multiple characterizations #1088

Merged
merged 2 commits into from
Dec 14, 2024

Conversation

StevenClontz
Copy link
Member

Closes #1086

@prabau
Copy link
Collaborator

prabau commented Dec 14, 2024

The suggestions seem ambiguous.

It used to be: Any of the following equivalent conditions: A, B, C, D.

Now: A, or any of the following equivalent conditions: B, C, D.
The meaning is: one of A, B, C, D. And B, C, D are equivalent. But A need not be equivalent to the other ones.

@prabau
Copy link
Collaborator

prabau commented Dec 14, 2024

Compare with https://topology.pi-base.org/properties/P000135, which is more carefully worded.

@prabau
Copy link
Collaborator

prabau commented Dec 14, 2024

I'll reiterate my comment from pi-base/web#177 (comment):

I think the most important thing is to have a clear and coherent text on each property page. What is displayed in the Properties list is not very important.

But I'll go along with this PR.

@StevenClontz StevenClontz marked this pull request as draft December 14, 2024 04:35
@StevenClontz StevenClontz removed the request for review from GeoffreySangston December 14, 2024 04:36
@GeoffreySangston
Copy link
Collaborator

GeoffreySangston commented Dec 14, 2024

Excluding the 'Any of the following equivalent properties holds:' examples, I think the following are all of properties with three or more definitions which contain "equivalent*", sorted by the way they're currently styled. Maybe we could decide on our favorite? I think we could change "Equivalently, any of the following equivalent properties holds:" to "This is equivalent to each of the following:".

  1. ("Equivalently:")
  1. ("Equivalently, any of the following equivalent properties holds:")
  1. (Separate paragraphs per "Equivalently".. There's a lot more in this style with only two definitions.)
  1. (In-paragraph equivalents.. possibly because the following paragraph works well with it.)
  1. ("And alternatively")

@prabau
Copy link
Collaborator

prabau commented Dec 14, 2024

I think we could change "Equivalently, any of the following equivalent properties holds:" to "This is equivalent to each of the following:".

Yeah, that reads much better, and is also correct.

@GeoffreySangston
Copy link
Collaborator

I don't mind doing the tedious work of switching these all to one style. Probably not for a few days.

@prabau
Copy link
Collaborator

prabau commented Dec 14, 2024

Hmm, what do you have in mind exactly? I think it's fine to change the introductory sentence when there is a list of bullet points. But in my opinion, we may not want/need to convert everything to bullet points.

I agree with splitting the paragraph for P15 (your category 4).

@GeoffreySangston
Copy link
Collaborator

GeoffreySangston commented Dec 14, 2024

  1. Definitely merging styles 1 and 2 into a single agreed upon version. And fixing 5. (And I figured 4 also.)
  2. Superseded possibly by switching everything to the style we thought was the best, yet to be determined. I guessed that would be bullet points, but I'm also happy not switching everything to one style if it's deemed too unimportant.

Maybe going forward we could agree on a favored style for new properties? I don't see why to prefer the separate paragraph style, because then following paragraphs aren't as easily distinguishable from equivalent definitions.

@prabau
Copy link
Collaborator

prabau commented Dec 14, 2024

I don't see why to prefer the separate paragraph style, because then following paragraphs aren't as easily distinguishable from equivalent definitions.

We'll have to play it by ear. I vaguely remember there were some cases of definitions involving multiple paragraphs, followed by some equivalent other characterizations in still other paragraphs. Forcing a bunch of paragraphs to be scrunched together in a single bullet does not seem optimal.

But overall, to me it does not seem very important if we don't have a uniform style for this. The main thing is to have something clear and unambiguous. And I am ok with having the first line more descriptive of the property, if some people care about that.

Also note: for just two definitions, there is no sense in using bullets.

@StevenClontz StevenClontz marked this pull request as ready for review December 14, 2024 17:11
Copy link
Collaborator

@GeoffreySangston GeoffreySangston left a comment

Choose a reason for hiding this comment

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

Sorry Steven. Afterwards I realized this would have been the ideal place to test out the 'suggestion' feature. I'll do it next time!

@GeoffreySangston GeoffreySangston merged commit fc962f5 into main Dec 14, 2024
1 check passed
@GeoffreySangston GeoffreySangston deleted the StevenClontz/propertyfirstlines branch December 14, 2024 17:32
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.

first line of descriptions
4 participants