Neater formatting of config description text

datasette/app.py

@@ -50,138 +50,80 @@ MEMORY = object()
 
 ConfigOption = collections.namedtuple("ConfigOption", ("name", "default", "help"))
 CONFIG_OPTIONS = (
-    ConfigOption(
+    ConfigOption("default_page_size", 100, "Default page size for the table view"),
-        "default_page_size",
-        100,
-        """
-        Default page size for the table view
-    """.strip(),
-    ),
     ConfigOption(
         "max_returned_rows",
         1000,
-        """
+        "Maximum rows that can be returned from a table or custom query",
-        Maximum rows that can be returned from a table or custom query
-    """.strip(),
     ),
     ConfigOption(
         "num_sql_threads",
         3,
-        """
+        "Number of threads in the thread pool for executing SQLite queries",
-        Number of threads in the thread pool for executing SQLite queries
-    """.strip(),
     ),
     ConfigOption(
-        "sql_time_limit_ms",
+        "sql_time_limit_ms", 1000, "Time limit for a SQL query in milliseconds"
-        1000,
-        """
-        Time limit for a SQL query in milliseconds
-    """.strip(),
     ),
     ConfigOption(
-        "default_facet_size",
+        "default_facet_size", 30, "Number of values to return for requested facets"
-        30,
-        """
-        Number of values to return for requested facets
-    """.strip(),
     ),
     ConfigOption(
-        "facet_time_limit_ms",
+        "facet_time_limit_ms", 200, "Time limit for calculating a requested facet"
-        200,
-        """
-        Time limit for calculating a requested facet
-    """.strip(),
     ),
     ConfigOption(
         "facet_suggest_time_limit_ms",
         50,
-        """
+        "Time limit for calculating a suggested facet",
-        Time limit for calculating a suggested facet
-    """.strip(),
     ),
     ConfigOption(
         "hash_urls",
         False,
-        """
+        "Include DB file contents hash in URLs, for far-future caching",
-        Include DB file contents hash in URLs, for far-future caching
-    """.strip(),
     ),
     ConfigOption(
         "allow_facet",
         True,
-        """
+        "Allow users to specify columns to facet using ?_facet= parameter",
-        Allow users to specify columns to facet using ?_facet= parameter
-    """.strip(),
     ),
     ConfigOption(
         "allow_download",
         True,
-        """
+        "Allow users to download the original SQLite database files",
-        Allow users to download the original SQLite database files
-    """.strip(),
-    ),
-    ConfigOption(
-        "suggest_facets",
-        True,
-        """
-        Calculate and display suggested facets
-    """.strip(),
-    ),
-    ConfigOption(
-        "allow_sql",
-        True,
-        """
-        Allow arbitrary SQL queries via ?sql= parameter
-    """.strip(),
     ),
+    ConfigOption("suggest_facets", True, "Calculate and display suggested facets"),
+    ConfigOption("allow_sql", True, "Allow arbitrary SQL queries via ?sql= parameter"),
     ConfigOption(
         "default_cache_ttl",
         5,
-        """
+        "Default HTTP cache TTL (used in Cache-Control: max-age= header)",
-        Default HTTP cache TTL (used in Cache-Control: max-age= header)
-    """.strip(),
     ),
     ConfigOption(
         "default_cache_ttl_hashed",
         365 * 24 * 60 * 60,
-        """
+        "Default HTTP cache TTL for hashed URL pages",
-        Default HTTP cache TTL for hashed URL pages
-    """.strip(),
     ),
     ConfigOption(
-        "cache_size_kb",
+        "cache_size_kb", 0, "SQLite cache size in KB (0 == use SQLite default)"
-        0,
-        """
-        SQLite cache size in KB (0 == use SQLite default)
-    """.strip(),
     ),
     ConfigOption(
         "allow_csv_stream",
         True,
-        """
+        "Allow .csv?_stream=1 to download all rows (ignoring max_returned_rows)",
-        Allow .csv?_stream=1 to download all rows (ignoring max_returned_rows)
-    """.strip(),
     ),
     ConfigOption(
         "max_csv_mb",
         100,
-        """
+        "Maximum size allowed for CSV export in MB - set 0 to disable this limit",
-        Maximum size allowed for CSV export in MB - set 0 to disable this limit
-    """.strip(),
     ),
     ConfigOption(
         "truncate_cells_html",
         2048,
-        """
+        "Truncate cells longer than this in HTML table view - set 0 to disable",
-        Truncate cells longer than this in HTML table view - set 0 to disable
-    """.strip(),
     ),
     ConfigOption(
         "force_https_urls",
         False,
-        """
+        "Force URLs in API output to always use https:// protocol",
-        Force URLs in API output to always use https:// protocol
-    """.strip(),
     ),
 )
 DEFAULT_CONFIG = {option.name: option.default for option in CONFIG_OPTIONS}