From f589dbc0772448b5554396cd410a863c63c77934 Mon Sep 17 00:00:00 2001 From: albertony <12441419+albertony@users.noreply.github.com> Date: Sun, 22 Aug 2021 15:11:41 +0200 Subject: [PATCH] docs: don't show fictional example values for options as multiple choice items See #5538 --- backend/ftp/ftp.go | 6 +----- backend/hdfs/hdfs.go | 13 +++---------- backend/http/http.go | 9 +-------- backend/sftp/sftp.go | 6 +----- backend/webdav/webdav.go | 6 +----- 5 files changed, 7 insertions(+), 33 deletions(-) diff --git a/backend/ftp/ftp.go b/backend/ftp/ftp.go index 69edce1b4..7a9e68e79 100644 --- a/backend/ftp/ftp.go +++ b/backend/ftp/ftp.go @@ -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 + ".", diff --git a/backend/hdfs/hdfs.go b/backend/hdfs/hdfs.go index c19971095..366411c0f 100644 --- a/backend/hdfs/hdfs.go +++ b/backend/hdfs/hdfs.go @@ -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", diff --git a/backend/http/http.go b/backend/http/http.go index 54bdd89e3..f1ef9a170 100644 --- a/backend/http/http.go +++ b/backend/http/http.go @@ -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. diff --git a/backend/sftp/sftp.go b/backend/sftp/sftp.go index 45031da78..1564ff90c 100644 --- a/backend/sftp/sftp.go +++ b/backend/sftp/sftp.go @@ -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 + ".", diff --git a/backend/webdav/webdav.go b/backend/webdav/webdav.go index 284c73487..7524ffc18 100644 --- a/backend/webdav/webdav.go +++ b/backend/webdav/webdav.go @@ -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.",