Document `gettext.c2py`

[tomasr8]

gettext.c2py is currently not documented. This function is used internally by GNUTranslations but it's also useful on its own when dealing with translations. I have a PR on the way ;)

Linked PRs

• gh-127373: Document gettext.c2py #127374

[serhiy-storchaka]

It is an internal function, it is not a part of the public API.

[tomasr8]

It is an internal function, it is not a part of the public API.

Ah I was under the impression that anything that is not underscored is de facto a public API, documented or not. I have actually used this function before under that assumption that it was public.

So in your opinion, do you think that we should not document this function? And more generally, how I can tell if something is or is not part of the public API?

[serhiy-storchaka]

It is not in __all__. Underscore is needed if __all__ is not used.

This function is not in the public API first, and all other (including the lack of documentation) is derivative.

[tomasr8]

Ok thanks! I was just wondering because I sent another PR (#127348) previously which documents traceback.print_list which is also not in __all__ but there were no objections to that one 😕

[serhiy-storchaka]

I am not sure about print_list, but c2py is clearly not purposed to be used by external code.

I think I already rejected a similar proposal for another gettext function. Prefixing with underscore is not required for private names, and the absence of an underscore prefix is not always a sign of a public name.

[tomasr8]

Got it, thanks for the clarification!