#2047619: Add a link generator service for route-based links introduced some weird one-line documentation for \Drupal\Core\Routing\UrlGenerator and \Drupal\Core\Utility\LinkGeneratorInterface. Probably just some typos.

I'm just reverting the documentation for UrlGenerator to what it previously was. It's not very descriptive, but it's at least technically correct.

Files: 
CommentFileSizeAuthor
#5 2091901-url-generator-docs-5.patch1.06 KBlongwave
PASSED: [[SimpleTest]]: [MySQL] 58,822 pass(es).
[ View ]
#3 2091901-url-generator-docs-3.patch1.06 KBlongwave
PASSED: [[SimpleTest]]: [MySQL] 58,955 pass(es).
[ View ]
url-generator-link-interface-typo.patch1.07 KBtstoeckler
PASSED: [[SimpleTest]]: [MySQL] 59,085 pass(es).
[ View ]

Comments

longwave’s picture

Status:Needs review» Reviewed & tested by the community

This is more correct than it was, and I can't think of a much better one line description for either of them.

jhodgdon’s picture

Status:Reviewed & tested by the community» Needs work

The new docs do not follow our standards (should start with a verb).
https://drupal.org/node/1354#classes

longwave’s picture

Status:Needs work» Needs review
StatusFileSize
new1.06 KB
PASSED: [[SimpleTest]]: [MySQL] 58,955 pass(es).
[ View ]

Is this better? A lot of classes seem to start with "Provides a..." but it seems better just to state exactly what it does.

jhodgdon’s picture

I think on the interface I would change it slightly to say:

Defines an interface for generating links with route names and parameters.

longwave’s picture

StatusFileSize
new1.06 KB
PASSED: [[SimpleTest]]: [MySQL] 58,822 pass(es).
[ View ]

I used your suggestion but "from" instead of "with" as that defines exactly what the interface does, to me at least.

jhodgdon’s picture

Status:Needs review» Reviewed & tested by the community

Looks good to me, thanks!

jhodgdon’s picture

Status:Reviewed & tested by the community» Fixed

Committed to 8.x. Thanks again!

Status:Fixed» Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.