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

Truncated sentence in applyConstraints() #1016

Open
eladalon1983 opened this issue Oct 2, 2024 · 2 comments
Open

Truncated sentence in applyConstraints() #1016

eladalon1983 opened this issue Oct 2, 2024 · 2 comments

Comments

@eladalon1983
Copy link
Member

In applyConstraints(), there is a truncated sentence that reads:

In step 3 of the ApplyConstraints algorithm, all changes listed are to be made to object, and

It is unlikely that the sentence was intended to

@eehakkin
Copy link
Contributor

eehakkin commented Oct 3, 2024

I don't think it is truncated. It is unclear for sure but not truncated.

I think that the full sentence is meant to be

Invoke and return the result of the applyConstraints template method where: [i]n the SelectSettings algorithm, [...], [i]n step 3 of the ApplyConstraints algorithm, all changes listed are to be made to object, and [i]n step 4 of the ApplyConstraints algorithm, the requirement on getConstraints() applies to the getConstraints() method of object.

I.e. there are three bullet points and the last two of them contains sentenses "In step 3 of the ApplyConstraints algorithm, all changes listed are to be made to object" and "In step 4 of the ApplyConstraints algorithm, the requirement on getConstraints() applies to the getConstraints() method of object" and these two sentences are delimited with "and".

@eladalon1983
Copy link
Member Author

eladalon1983 commented Oct 3, 2024

image


The sentence ends with the word "and". That's not one of the traditional ways of jumping to the next bullet point. More traditional ways are:

  • Simply ending the previous bullet point, then letting the next bullet start a new sentence.
  • Ending a sentence with "..." and having the next sentence begin with "..." as well.

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

No branches or pull requests

2 participants