From 0652705cf0696c14f8cc28eaf89d57724309a3b4 Mon Sep 17 00:00:00 2001 From: "Billy \"Hyun Joon\" Seol" Date: Fri, 15 Jun 2018 19:46:45 -0700 Subject: [PATCH] adding more documentation for python_app (#5965) ### Problem The python_app target doesn't have the documentation specific for it and has a documentation that is specific to jvm_app. ### Solution Added a few lines of documentation. ### Result There is no system-wide change, only a documentation change. --- src/python/pants/backend/python/targets/python_app.py | 10 ++++++++++ src/python/pants/build_graph/app_base.py | 4 ++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/src/python/pants/backend/python/targets/python_app.py b/src/python/pants/backend/python/targets/python_app.py index 5f5a142641b..4643ce2e511 100644 --- a/src/python/pants/backend/python/targets/python_app.py +++ b/src/python/pants/backend/python/targets/python_app.py @@ -10,6 +10,16 @@ class PythonApp(AppBase): + """A deployable Python application. + + Invoking the ``bundle`` goal on one of these targets creates a + self-contained artifact suitable for deployment on some other machine. + The artifact contains the executable pex, its dependencies, and + extra files like config files, startup scripts, etc. + + :API: public + """ + @classmethod def alias(cls): return 'python_app' diff --git a/src/python/pants/build_graph/app_base.py b/src/python/pants/build_graph/app_base.py index 517246b2e22..30121ab8b88 100644 --- a/src/python/pants/build_graph/app_base.py +++ b/src/python/pants/build_graph/app_base.py @@ -212,8 +212,8 @@ def __init__(self, archive=None, **kwargs): """ - :param string binary: Target spec of the ``jvm_binary`` that contains the - app main. + :param string binary: Target spec of the ``jvm_binary`` or the ``python_binary`` + that contains the app main. :param bundles: One or more ``bundle``\s describing "extra files" that should be included with this app (e.g.: config files, startup scripts).