Eric Snow wrote:
We will mark it "provisional" in the docs, which I expect will include info on what that means and why it is provisional.
If you'd like an example format for marking a section of the docs as provisional w/ reST, something like this at the top should suffice (with perhaps something more specific to the subinterpreters module): .. note:: This section of the documentation and all of its members have been added *provisionally*. For more details, see :term:`provisional api`. :term:`provisional api` generates a link to https://docs.python.org/3/glossary.html#term-provisional-api. On Tue, Apr 21, 2020 at 12:09 PM Eric Snow <ericsnowcurrently@gmail.com> wrote:
On Tue, Apr 21, 2020 at 7:25 AM Victor Stinner <vstinner@python.org> wrote:
Would it make sense to start by adding the module as a private "_subinterpreters" module but document it? The "_" prefix would be a reminder that "hey! it's experimental, there is a no backward compatibility warranty there".
I would expect a leading underscore to be confusing (as well as conflicting with the name of the low-level module). if we did anything then it would probably make more sense to name the module something like "interpreters_experimental". However, I'm not sure that offers that much benefit.
We can also add a big warning in the documentation.
We will mark it "provisional" in the docs, which I expect will include info on what that means and why it is provisional.
-eric _______________________________________________ Python-Dev mailing list -- python-dev@python.org To unsubscribe send an email to python-dev-leave@python.org https://mail.python.org/mailman3/lists/python-dev.python.org/ Message archived at https://mail.python.org/archives/list/python-dev@python.org/message/LB7ACPFA... Code of Conduct: http://python.org/psf/codeofconduct/