Come together with the global Drupal community in Rotterdam, 28 Sept – 1 Oct 2026. Sessions, contribution, connection, and Early Bird savings until 8 June.#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.
| Comment | File | Size | Author |
|---|---|---|---|
| #5 | 2091901-url-generator-docs-5.patch | 1.06 KB | longwave |
| #3 | 2091901-url-generator-docs-3.patch | 1.06 KB | longwave |
| url-generator-link-interface-typo.patch | 1.07 KB | tstoeckler |
Comments
Comment #1
longwaveThis is more correct than it was, and I can't think of a much better one line description for either of them.
Comment #2
jhodgdonThe new docs do not follow our standards (should start with a verb).
https://drupal.org/node/1354#classes
Comment #3
longwaveIs this better? A lot of classes seem to start with "Provides a..." but it seems better just to state exactly what it does.
Comment #4
jhodgdonI think on the interface I would change it slightly to say:
Defines an interface for generating links with route names and parameters.
Comment #5
longwaveI used your suggestion but "from" instead of "with" as that defines exactly what the interface does, to me at least.
Comment #6
jhodgdonLooks good to me, thanks!
Comment #7
jhodgdonCommitted to 8.x. Thanks again!