Skip to content

[hotfix][python][docs] Fix python.archives docs #15783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
t0t07 wants to merge 2 commits into from
Closed

[hotfix][python][docs] Fix python.archives docs #15783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd05606
[hotfix][python][docs] Fix python.archives docs
t0t07 Apr 27, 2021
f913eb0
gen docs
t0t07 Apr 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content.zh/docs/dev/table/sqlClient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ Mode "embedded" (default) submits Flink jobs from the local machine.
target directory be specified. If the
target directory name is specified,
the archive file will be extracted to
a name can directory with the
a directory with the
specified name. Otherwise, the
archive file will be extracted to a
directory with the same name of the
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/dev/table/sqlClient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ Mode "embedded" (default) submits Flink jobs from the local machine.
target directory be specified. If the
target directory name is specified,
the archive file will be extracted to
a name can directory with the
a directory with the
specified name. Otherwise, the
archive file will be extracted to a
directory with the same name of the
Expand Down
2 changes: 1 addition & 1 deletion docs/layouts/shortcodes/generated/python_configuration.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<td><h5>python.archives</h5></td>
<td style="word-wrap: break-word;">(none)</td>
<td>String</td>
<td>Add python archive files for job. The archive files will be extracted to the working directory of python UDF worker. Currently only zip-format is supported. For each archive file, a target directory is specified. If the target directory name is specified, the archive file will be extracted to a name can directory with the specified name. Otherwise, the archive file will be extracted to a directory with the same name of the archive file. The files uploaded via this option are accessible via relative path. '#' could be used as the separator of the archive file path and the target directory name. Comma (',') could be used as the separator to specify multiple archive files. This option can be used to upload the virtual environment, the data files used in Python UDF. The data files could be accessed in Python UDF, e.g.: f = open('data/data.txt', 'r'). The option is equivalent to the command line option "-pyarch".</td>
<td>Add python archive files for job. The archive files will be extracted to the working directory of python UDF worker. Currently only zip-format is supported. For each archive file, a target directory is specified. If the target directory name is specified, the archive file will be extracted to a directory with the specified name. Otherwise, the archive file will be extracted to a directory with the same name of the archive file. The files uploaded via this option are accessible via relative path. '#' could be used as the separator of the archive file path and the target directory name. Comma (',') could be used as the separator to specify multiple archive files. This option can be used to upload the virtual environment, the data files used in Python UDF. The data files could be accessed in Python UDF, e.g.: f = open('data/data.txt', 'r'). The option is equivalent to the command line option "-pyarch".</td>
</tr>
<tr>
<td><h5>python.client.executable</h5></td>
Expand Down
2 changes: 1 addition & 1 deletion flink-clients/src/main/java/org/apache/flink/client/cli/CliFrontendParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ public class CliFrontendParser {
"Add python archive files for job. The archive files will be extracted to the working directory "
+ "of python UDF worker. Currently only zip-format is supported. For each archive file, a target directory "
+ "be specified. If the target directory name is specified, the archive file will be extracted to a "
+ "name can directory with the specified name. Otherwise, the archive file will be extracted to a "
+ "directory with the specified name. Otherwise, the archive file will be extracted to a "
+ "directory with the same name of the archive file. The files uploaded via this option are accessible "
+ "via relative path. '#' could be used as the separator of the archive file path and the target directory "
+ "name. Comma (',') could be used as the separator to specify multiple archive files. "
Expand Down
2 changes: 1 addition & 1 deletion flink-python/src/main/java/org/apache/flink/python/PythonOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ public class PythonOptions {
"Add python archive files for job. The archive files will be extracted "
+ "to the working directory of python UDF worker. Currently only zip-format is "
+ "supported. For each archive file, a target directory is specified. If the target "
+ "directory name is specified, the archive file will be extracted to a name can "
+ "directory name is specified, the archive file will be extracted to a "
+ "directory with the specified name. Otherwise, the archive file will be extracted to "
+ "a directory with the same name of the archive file. The files uploaded via this "
+ "option are accessible via relative path. '#' could be used as the separator of the "
Expand Down