github-mirror/rclone
2
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2024-11-22 14:51:48 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: don't show fictional example values for options as multiple choice items

Browse Source 
See #5538
This commit is contained in:
albertony 2021-08-22 15:11:41 +02:00
parent 8efead1ee6
commit f589dbc077
5 changed files with 7 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
backend/ftp/ftp.go
View File

@ -48,12 +48,8 @@ func init() {
NewFs: NewFs,
Options: []fs.Option{{
Name: "host",
Help: "FTP host to connect to.",
Help: "FTP host to connect to.\n\nE.g. \"ftp.example.com\".",
Required: true,
Examples: []fs.OptionExample{{
Value: "ftp.example.com",
Help: "Connect to ftp.example.com",
}},
}, {
Name: "user",
Help: "FTP username, leave blank for current username, " + currentUser + ".",

13
backend/hdfs/hdfs.go
View File

@ -19,12 +19,8 @@ func init() {
NewFs: NewFs,
Options: []fs.Option{{
Name: "namenode",
Help: "Hadoop name node and port.",
Help: "Hadoop name node and port.\n\nE.g. \"namenode:8020\" to connect to host namenode at port 8020.",
Required: true,
Examples: []fs.OptionExample{{
Value: "namenode:8020",
Help: "Connect to host namenode at port 8020.",
}},
}, {
Name: "username",
Help: "Hadoop user name.",
@ -38,12 +34,9 @@ func init() {
Help: `Kerberos service principal name for the namenode.
Enables KERBEROS authentication. Specifies the Service Principal Name
(SERVICE/FQDN) for the namenode.`,
(SERVICE/FQDN) for the namenode. E.g. \"hdfs/namenode.hadoop.docker\"
for namenode running as service 'hdfs' with FQDN 'namenode.hadoop.docker'.`,
Required: false,
Examples: []fs.OptionExample{{
Value: "hdfs/namenode.hadoop.docker",
Help: "Namenode running as service 'hdfs' with FQDN 'namenode.hadoop.docker'.",
}},
Advanced: true,
}, {
Name: "data_transfer_protection",

9
backend/http/http.go
View File

@ -38,15 +38,8 @@ func init() {
NewFs: NewFs,
Options: []fs.Option{{
Name: "url",
Help: "URL of http host to connect to.",
Help: "URL of http host to connect to.\n\nE.g. \"https://example.com\", or \"https://user:pass@example.com\" to use a username and password.",
Required: true,
Examples: []fs.OptionExample{{
Value: "https://example.com",
Help: "Connect to example.com.",
}, {
Value: "https://user:pass@example.com",
Help: "Connect to example.com using a username and password.",
}},
}, {
Name: "headers",
Help: `Set HTTP headers for all transactions.

6
backend/sftp/sftp.go
View File

@ -56,12 +56,8 @@ func init() {
NewFs: NewFs,
Options: []fs.Option{{
Name: "host",
Help: "SSH host to connect to.",
Help: "SSH host to connect to.\n\nE.g. \"example.com\".",
Required: true,
Examples: []fs.OptionExample{{
Value: "example.com",
Help: "Connect to example.com.",
}},
}, {
Name: "user",
Help: "SSH username, leave blank for current username, " + currentUser + ".",

6
backend/webdav/webdav.go
View File

@ -70,12 +70,8 @@ func init() {
NewFs: NewFs,
Options: []fs.Option{{
Name: "url",
Help: "URL of http host to connect to.",
Help: "URL of http host to connect to.\n\nE.g. https://example.com.",
Required: true,
Examples: []fs.OptionExample{{
Value: "https://example.com",
Help: "Connect to example.com.",
}},
}, {
Name: "vendor",
Help: "Name of the Webdav site/service/software you are using.",