Skip to content

Collection of fixes: Typos, Formatting, Logic, Links #3173

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

Merged
merged 5 commits into from
Nov 12, 2013
Merged

Collection of fixes: Typos, Formatting, Logic, Links #3173

merged 5 commits into from
Nov 12, 2013

Conversation

bicpi
Copy link
Contributor

@bicpi bicpi commented Nov 8, 2013

Q A
Doc fix? yes
New docs? -
Applies to 2.2+
Fixed tickets -

I've summarized some minor issues in this PR.

Please comment if something is wrong - I'll do an update then.

@@ -66,7 +66,7 @@ Synthetic services are services that are injected into the container instead
of being created by the container.

For example, if you're using the :doc:`HttpKernel </components/http_kernel/introduction>`
component with the DependencyInjection component, then the ``request``
component with the Dependency Injection component, then the ``request``
Copy link
Member

Choose a reason for hiding this comment

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

-1

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was the only usage of this notation without space in the docs vs. five time with space (for usage as component name only, i.e. without the design pattern context).

I also found that some other component names are used inconsistently, e.g. we have:

  • EventDispatcher vs. Event Dispatcher
  • HttpKernel vs. HTTP Kernel
  • ClassLoader vs. Class Loader
  • etc.

For instance, in the TOC it says Class Loader, then The Class Loader component and then elsewhere When using the ClassLoader component.... You can find similiar examples for the other components. Maybe it's okay to say "Class Loader" when not directly refering to the component (e.g. in the main heading in the TOC), because it refers to a Class Loader in general. But when used in the context of a Symfony component it should be either ClassLoader component or Class Loader component everywhere.

In addition I found Swift Mailer vs. Swiftmailer - but even the Swift Mailer docs itself does not agree upon this - but Swift Mailer seems to be on the majority there - except for the logo ;-)

If we aggree on a notation I can update the docs if you like.

Copy link
Member

Choose a reason for hiding this comment

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

Let's use this page as the standard :) - http://symfony.com/components

So, call the components by their actual, "code" name. I'd be happy to have things consistent around that standard.

Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree with the "code" name. I will update as much as I can find soon. I think I should pay attention to places where it it used in the "general" sense as e.g. the "Dependecy Injection pattern" etc.

What do you think about "Swift Mailer" as the "official" name?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, it's Swift Mailer

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've updated to "Swift Mailer" notation and also fixed some literal notations of Swiftmailer to Swift Mailer.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've reverted the "DependencyInjection" to "Dependency Injection" change.

I think updating to consistent component names should be done in a separate PR because it's a lot of changes and so it would be hard to read if it's mixed with the other changes here. I also found an inconsistency in SomeComponent component vs. SomeComponent Component (not only in the headings). What do you prefer?

If this PR is ok now, please feel free to merge 😄

Copy link
Member

Choose a reason for hiding this comment

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

Headlines: capitalized component
Normal text: lowercase component

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agree with that, I'll provide a new PR soon.

weaverryan added a commit that referenced this pull request Nov 12, 2013
…lection

Collection of fixes: Typos, Formatting, Logic, Links
@weaverryan weaverryan merged commit 2811ac0 into symfony:2.2 Nov 12, 2013
@weaverryan
Copy link
Member

Wow, this is really great. Thanks so much Philipp!

@bicpi bicpi deleted the fixing_typos_formatting_logic_collection branch January 5, 2014 13:24
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.

3 participants