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

[Best Practices] weird link captions in cross references #4822

Closed
dbu opened this issue Jan 13, 2015 · 3 comments
Closed

[Best Practices] weird link captions in cross references #4822

dbu opened this issue Jan 13, 2015 · 3 comments

Comments

@dbu
Copy link
Contributor

dbu commented Jan 13, 2015

The best practices articles have many places where a cross reference uses the full title of a cookbook entry or doc chapter, making for weird grammar: "If you need to execute some code before or after the execution of your controllers, you can use the EventDispatcher component to How to Setup before and after Filters." for example, http://symfony.com/doc/2.3/best_practices/controllers.html#pre-and-post-hooks

almost every section has one of those links. not harmful, but a bit confusing.

@javiereguiluz
Copy link
Member

@dbu I agree that these cross references are pretty bad. Thanks for reporting it!

I'll take care of fixing this issue.

@wouterj
Copy link
Member

wouterj commented Jan 13, 2015

I always prefer to use quotes when referencing articles: If you need to execute some code before or after the execution of your controllers, you can use the EventDispatcher component to "How to Setup before and after Filters".

However, I know @weaverryan isn't a big fan of this

@xabbuh
Copy link
Member

xabbuh commented Jan 13, 2015

@wouterj At least, imho you example doesn't read really better. I would prefer to set the link text manually here.

weaverryan added a commit that referenced this issue Jan 16, 2015
…ked wrong (javiereguiluz)

This PR was merged into the 2.3 branch.

Discussion
----------

Add custom link labels where Cookbook articles titles looked wrong

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets | #4822

Commits
-------

1b31ad1 Add custom link labels where Cookbook articles titles looked wrong
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

5 participants