Skip to content

Commit

Permalink
adding more documentation for python_app (#5965)
Browse files Browse the repository at this point in the history
### 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.
  • Loading branch information
tglstory authored and Stu Hood committed Jun 16, 2018
1 parent e749782 commit 0652705
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
10 changes: 10 additions & 0 deletions src/python/pants/backend/python/targets/python_app.py
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
4 changes: 2 additions & 2 deletions src/python/pants/build_graph/app_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit 0652705

Please sign in to comment.