Skip to content

Fix usage of "e.g." and "etc." #19186

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

Closed
wants to merge 5 commits into from
Closed

Conversation

smnandre
Copy link
Member

Dears doc maintainers 💐 , if you don't have time for this one or don't want to fix typographic details... i'll understand :)

@smnandre smnandre requested a review from xabbuh as a code owner November 25, 2023 13:59
@carsonbot carsonbot added this to the 6.4 milestone Nov 25, 2023
@@ -238,7 +238,7 @@ Use Dependency Injection to Get Services
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you extend the base ``AbstractController``, you can only get access to the most
common services (e.g ``twig``, ``router``, ``doctrine``, etc.), directly from the
common services (e.g. ``twig``, ``router``, ``doctrine``), directly from the
Copy link
Member

Choose a reason for hiding this comment

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

I think this should become

Suggested change
common services (e.g. ``twig``, ``router``, ``doctrine``), directly from the
common services (e.g. ``twig``, ``router`` and ``doctrine``), directly from the

same for all other changes where you removed "etc" on lists following "e.g."

Copy link
Member Author

Choose a reason for hiding this comment

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

Even with two examples?

A:  (e.g. twig, router)
B:  (e.g. twig and router)
C:  (e.g. twig or router)

Copy link
Member

Choose a reason for hiding this comment

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

Yes, I think so.

This comment was marked as outdated.

Copy link
Member Author

@smnandre smnandre Nov 26, 2023

Choose a reason for hiding this comment

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

To be honest I'm in doubt what to do @wouterj

There are a lot of places where (e.g. "example_a", "example_b") is used (before my modifications i mean)..

Should i change those too ? Or maybe, on the contrary, could we set the following rule:

a set of single terms (values, code identifier, methods, etc.) can be listed without "and", to avoid any sense of relation

We also could say

we'd rather handle this on a case-per-case basis, so let's stop there for now

and i'll drop the commit "e.g. and etc. used together"

WDYT ?

@smnandre smnandre requested a review from wouterj December 1, 2023 18:48
@@ -238,7 +238,7 @@ Use Dependency Injection to Get Services
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you extend the base ``AbstractController``, you can only get access to the most
common services (e.g ``twig``, ``router``, ``doctrine``, etc.), directly from the
common services (e.g. ``twig``, ``router`` and ``doctrine``), directly from the
Copy link
Member

Choose a reason for hiding this comment

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

I'd say this change is wrong because the AbstractConroller gives you access to lots of services ... and not only those 3. See:

https://github.com/symfony/symfony/blob/b004c3c6d120c4d16988c97bf01268adfe960cb1/src/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.php#L83-L95

Copy link
Member

@javiereguiluz javiereguiluz left a comment

Choose a reason for hiding this comment

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

I'd keep most of the etc. usages removed in this PR. Without the etc., the text is "wrong" now (because in most cases we have many more items than the one listed explicitly).

@smnandre
Copy link
Member Author

smnandre commented Jan 12, 2024

I'd keep most of the etc. usages removed in this PR. Without the etc., the text is "wrong" now (because in most cases we have many more items than the one listed explicitly).

It was the reason of this PR. The "e.g." and "etc" mean the same thing. They introduce (or "outroduce" for etc) a non-exhaustive list.

My personal preference would be to use etc and replace e.g / i.e. with simpler terms: "such as"; "like" ...
... but as i'm not a native speaker (neither a regular one) i'd rather let you decide.

Originally the goal of this PR was to make some quick corrections / fixes, but if that means losing some readability and/or losing time to anyone here clearly let's close it's not worth this energy :)

@OskarStark
Copy link
Contributor

Thanks for proposing, let's keep it this way 👌🏻😎

@OskarStark OskarStark closed this May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants