[issue40344] Programming FAQ about "What is the most efficient way to concatenate many strings together?" -- Improving the example

[Dominik V.]

Dominik V. <dominik.vilsmeier1123 at gmail.com> added the comment:

It was not my intention to disturb the traffic on the bug tracker. My apologies if that caused any trouble. I also thought only people subscribed to the indicated topic (e.g. "Documentation") would receive a notification.

The docs pages mention that for enhancement proposals one should submit a bug report on the tracker:

> If you find a bug in this documentation or would like to propose an improvement, please submit a bug report on the tracker (https://docs.python.org/3/bugs.html).

I do care about the quality of Python's documentation and I think it could be improved in these cases. Often it is newcomers who consult these pages and they might be irritated by the mentioned parts.

I see how it would be distracting to include a more complex real world example, but using an example which performs apparently superfluous steps without any additional comment might seem strange. More experienced users probably won't need such an example at all. In addition it might make people falsely belief that `str.join` expects a list of strings rather than any iterable, and hence the explicit construction of the list.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue40344>
_______________________________________