docs: beef up the ProjectBuilder's method docstrings
#178
Conversation
src/build/__init__.py
Outdated
| @@ -169,6 +169,9 @@ def __init__(self, srcdir, config_settings=None, python_executable=sys.executabl | |||
|
|
|||
| @property | |||
| def python_executable(self): # type: () -> Union[bytes, Text] | |||
| """ | |||
| The Python executable used by :mod:`pep517` to invoke the backend. | |||
There was a problem hiding this comment.
Using pep517 is an implementation detail, please remove the reference.
There was a problem hiding this comment.
I considered he made the reference here as pep 517 the API, not the package. And in that sense the sentence is right and does not exposes implementation details.
There was a problem hiding this comment.
It was meant for the package. I'm not sure what the 'executable used by the PEP 517 API' would mean in this context.
There was a problem hiding this comment.
Well, the python executable hosting the build backend (as opposed to the build frontend - current process), https://www.python.org/dev/peps/pep-0517/#build-backend-interface, what else could it?
There was a problem hiding this comment.
@gaborbernat I mean that it'd have been confusing to introduce another concept (the 'API') in addition to the frontend and backend - it'd have been somewhat of a tautology. If we wanted to throw PEP 517 in there, I'd have rephrased it as:
The Python executable used to invoke the PEP 517 backend.
But I think it goes without saying that the backend conforms to PEP 517 - build is a PEP 517 frontend.
layday
force-pushed
the
beef-up-docstrings
branch
from
48c71c7
to
3db205f
Compare
No description provided.