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

docs: Some typos in cli/cli_library.rst #8941

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from

Conversation

obozdag
Copy link
Contributor

@obozdag obozdag commented Jun 9, 2024

Description
Some typos in cli/cli_library.rst

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

Some typos in cli/cli_library.rst
Change double quates to single for consistency in cli/cli_library/017.php
@kenjis kenjis added the documentation Pull requests for documentation only label Jun 10, 2024
kenjis
kenjis previously approved these changes Jun 10, 2024
user_guide_src/source/cli/cli_library.rst Outdated Show resolved Hide resolved
@@ -203,7 +203,7 @@ Would create something like this:
text of the printing and
typesetting industry.
task1abc Lorem Ipsum has been the
industry's standard dummy
industry standard dummy
Copy link
Member

Choose a reason for hiding this comment

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

The apostrophe here is correct.

Copy link
Member

Choose a reason for hiding this comment

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

ChatGPT said "industry standard" is correct.

The following is an answer by Claude 3 Sonnet.
Is this explanation correct?


Both "industry's standard" and "industry standard" are grammatically correct in English, but they have slightly different meanings and usages.

  1. "Industry standard" (without an apostrophe)
    This term refers to a standard, practice, or specification that is widely accepted and used within a particular industry. It is the norm or generally accepted way of doing something in that industry. For example:
  • USB is an industry standard for connecting peripheral devices to computers.
  • PDF has become an industry standard for sharing documents across different platforms.
  1. "Industry's standard" (with an apostrophe)
    This phrase refers to the specific standard or norm that is used or accepted by a particular industry. It is more explicit in indicating that the standard belongs to or is associated with a specific industry. For example:
  • The construction industry's standard for safety equipment has become more stringent.
  • The automotive industry's standard for fuel efficiency has been revised.

In most cases, "industry standard" without the apostrophe is more common and idiomatic when referring to a widely accepted norm or practice within an industry. However, "industry's standard" can be used when you want to emphasize that the standard is specific to a particular industry or clarify which industry you are referring to.

Copy link
Member

Choose a reason for hiding this comment

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

From https://www.lipsum.com/

Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s [...]

In this case we can rewrite the 2nd sentence as "Lorem ipsum has been the standard dummy text of the [printing and typesetting] industry ever since the 1500s [...]"

Another way to look at it is this: industry standard is a noun; if we mean it that way, we cannot use it as an adjective for "dummy text"

Copy link
Member

@kenjis kenjis Jun 13, 2024

Choose a reason for hiding this comment

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

@paulbalandan Thank you. I got it.

I fixed the question, but ChatGPT still says "industry standard" is correct. It seems s/he likes the phrase. https://chatgpt.com/share/0c469d88-dc36-40ed-9ab9-b8c179db89b0

Gemini says "industry's standard" is grammatically correct.

@@ -8,7 +8,7 @@
];
$descriptions = [
'Lorem Ipsum is simply dummy text of the printing and typesetting industry.',
"Lorem Ipsum has been the industry's standard dummy text ever since the",
'Lorem Ipsum has been the industry standard dummy text ever since the',
Copy link
Member

Choose a reason for hiding this comment

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

The apostrophe is correct here.

Put period at the end of the list in cli/cli_library.rst
@kenjis kenjis dismissed their stale review June 13, 2024 00:31

"the industry's standard dummy text" is correct.

@obozdag
Copy link
Contributor Author

obozdag commented Jun 13, 2024

@kenjis, @paulbalandan I didn't say "the industry's standard" is incorrect. In this code example for wrap() method:

$descriptions = [
    'Lorem Ipsum is simply dummy text of the printing and typesetting industry.',
    "Lorem Ipsum has been the industry's standard dummy text ever since the",
];

$descriptions array has two elements. One string element is single quoted, second is double quoted. Why? Only because the second has a single quotation mark in it. I tried to make the quotation marks the same in two elements to keep the readers attention on what wrap() method does. I have changed the quotation marks to single in the second element and as a natural result of this change I have changed the output on line 206. Whatever the text In this example is not important. But if you say that we should keep the example as is, I can roll back the changes. Or you can offer another sentence which doesn't distract user's attention.

@paulbalandan
Copy link
Member

@obozdag thanks for clarifying your intent. in this case let's just use single quotes also and just escape the apostrophe inside: industry\'s

Change wrap example text in cli/cli_library/017.php to avoid debate on the content and keep the attention on what wrap() function does.
Change wrap() output according to the changed example in cli/cli_library.rst
Comment on lines +10 to +11
'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris congue est sit amet turpis laoreet porta.',
'Mauris iaculis eleifend ultricies. Sed mollis urna in ultricies hendrerit. Mauris dictum, est a euismod',
Copy link
Member

Choose a reason for hiding this comment

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

What are these sentences? Why not English?

@kenjis kenjis added the waiting for info Issues or pull requests that need further clarification from the author label Jun 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests for documentation only waiting for info Issues or pull requests that need further clarification from the author
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants