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

Stick to third-person singular form in target and option docs #340

Merged
merged 4 commits into from
Jan 11, 2024

Conversation

muzimuzhi
Copy link
Contributor

No description provided.

@josephwright josephwright requested a review from car222222 January 5, 2024 18:19
Copy link

@car222222 car222222 left a comment

Choose a reason for hiding this comment

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

Three(?) places “and exit.” should become “and exits.”
Similarly, “simply rerun tests” probably should become “… reruns …”

Aside: I cannot parse this sentence: … to … to … ?? —
Applies the Lua |update_tag()| function to modify the contents of files specified by |tagfiles| to update the `release tag' (or package version) and date.

Aside: Should this have been: … run, even if … —
Forces tests to run if engine is not set up

muzimuzhi and others added 2 commits January 8, 2024 00:29
Co-authored-by: Chris Rowley <latex-bugs@latex-project.org>
Co-authored-by: Chris Rowley <latex-bugs@latex-project.org>
@muzimuzhi muzimuzhi requested a review from car222222 January 7, 2024 16:40
@muzimuzhi
Copy link
Contributor Author

Hmm the "Co-authored-by" trailers in git commit messages don't work as expected.

@josephwright
Copy link
Member

We good to go here?

Copy link
Member

@FrankMittelbach FrankMittelbach left a comment

Choose a reason for hiding this comment

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

looks fine to me (but what do I know :-) )

Copy link

@car222222 car222222 left a comment

Choose a reason for hiding this comment

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

Apologies for the delay.

I am not familiar with “assertions”, or the way that they are normally defined or described.
But the ”assert” here looks strange here! “true if . . . “ would be normal English:
assert if the full expansion of \meta{arg_1} and \meta{arg_2} are the same:

Copy link

@car222222 car222222 left a comment

Choose a reason for hiding this comment

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

Lines 594-6.
I think that the following is much clearer (if accurate:-) :

Applies the Lua |update_tag()| function to modify the contents of
all the filesspecified by |tagfiles|:
this function updates the `release tag' (or package version)
and date.

@car222222
Copy link

@josephwright (I guess).

The major problem with the \ASSERT item in this list is that it does not say anything about what actually gets written to the log file.

Thus it seems to need a total rewrite.
Or am I missing something?

@josephwright
Copy link
Member

@car222222 Well perhaps but that's a separate issue - suggest we agree on the PR here then I re-work that sentence later.

@car222222
Copy link

@josephwright Agreed that this is something else again!
Therefore I did approve this PR.

@josephwright josephwright merged commit d76eb50 into latex3:main Jan 11, 2024
1 check passed
@car222222
Copy link

My comment on Lines 594-6 got mangled a bit, try this instead.

Applies the Lua |update_tag()| function
to modify the contents of
all the files specified by |tagfiles|;
this function updates the `release tag'
(or package version) and the date.

@josephwright
Copy link
Member

My comment on Lines 594-6 got mangled a bit, try this instead.

@car222222 Added as 0231d16

@josephwright
Copy link
Member

Well perhaps but that's a separate issue - suggest we agree on the PR here then I re-work that sentence later.

@car222222 3e8067e

@car222222
Copy link

I think that a space got lost in 0231d16, should be "; this". Probably my fault.

@muzimuzhi muzimuzhi deleted the docs/third-person-singular branch January 11, 2024 17:07
muzimuzhi added a commit to muzimuzhi/l3build that referenced this pull request Jan 11, 2024
Introduced in 0231d16 (Update from Chris, 2024-01-11) and pointed out by Chris
in latex3#340 (comment).
josephwright pushed a commit that referenced this pull request Jan 11, 2024
Introduced in 0231d16 (Update from Chris, 2024-01-11) and pointed out by Chris
in #340 (comment).
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.

4 participants