CLI tool documentation shows complicated way of creating a HelperSet #6457

Closed
opened 2026-01-22 15:33:34 +01:00 by admin · 4 comments
Owner

Originally created by @gbirke on GitHub (May 4, 2020).

Hi,

The CLI setup section at https://www.doctrine-project.org/projects/doctrine-orm/en/2.7/reference/tools.html still shows how to manually create a HelperSet, while the introductory documentation at https://www.doctrine-project.org/projects/doctrine-orm/en/2.7/reference/configuration.html#setting-up-the-commandline-tool shows that you can just call ConsoleRunner::createHelperSet($entityManager)

I'd either remove all the detailed setup or put the short call to ConsoleRunner::createHelperSet($entityManager); first.

Originally created by @gbirke on GitHub (May 4, 2020). Hi, The CLI setup section at https://www.doctrine-project.org/projects/doctrine-orm/en/2.7/reference/tools.html still shows how to manually create a HelperSet, while the introductory documentation at https://www.doctrine-project.org/projects/doctrine-orm/en/2.7/reference/configuration.html#setting-up-the-commandline-tool shows that you can just call `ConsoleRunner::createHelperSet($entityManager)` I'd either remove all the detailed setup or put the short call to `ConsoleRunner::createHelperSet($entityManager);` first.
admin added the Documentation label 2026-01-22 15:33:34 +01:00
admin closed this issue 2026-01-22 15:33:34 +01:00
Author
Owner

@SenseException commented on GitHub (May 4, 2020):

Yes, the occurrances of the direct usage of HelperSet is from a time before 2.4. This is of course outdated by now. In #8002 we removed the references of an ORM version starting with the in the 2.8 branch and keep the ConsoleRunner in favour of the HelperSet.

As your links point it out, there's still work to do. I suggest to adapt the documentation for the usage of ConsoleRunner in https://www.doctrine-project.org/projects/doctrine-orm/en/2.7/reference/tools.html. Do you like to create a PR for that?

@SenseException commented on GitHub (May 4, 2020): Yes, the occurrances of the direct usage of `HelperSet` is from a time before 2.4. This is of course outdated by now. In #8002 we removed the references of an ORM version starting with the in the 2.8 branch and keep the `ConsoleRunner` in favour of the `HelperSet`. As your links point it out, there's still work to do. I suggest to adapt the documentation for the usage of `ConsoleRunner` in https://www.doctrine-project.org/projects/doctrine-orm/en/2.7/reference/tools.html. Do you like to create a PR for that?
Author
Owner

@gbirke commented on GitHub (May 5, 2020):

I'd be happy to provide a documentation patch. For version 2.8 or 2.7?

@gbirke commented on GitHub (May 5, 2020): I'd be happy to provide a documentation patch. For version 2.8 or 2.7?
Author
Owner

@SenseException commented on GitHub (May 5, 2020):

I'd say 2.8.

@SenseException commented on GitHub (May 5, 2020): I'd say 2.8.
Author
Owner

@beberlei commented on GitHub (Jul 5, 2020):

Fixed in #8130

@beberlei commented on GitHub (Jul 5, 2020): Fixed in #8130
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: doctrine/archived-orm#6457