summaryrefslogtreecommitdiff
path: root/inc
diff options
context:
space:
mode:
authorMichael Foster <savetheinternet@tinyboard.org>2013-08-21 22:41:42 +1000
committerMichael Foster <savetheinternet@tinyboard.org>2013-08-21 22:41:42 +1000
commitb01a402d23a1e7dd94ef2b9980a055c07d332f9d (patch)
treef1722215e4502fff0f3e4875a69d8a8cb1506b65 /inc
parentcbfafeea3636e222feb73cf42c24fec16bff71bd (diff)
4chan-compatible api: better config.php comments
Diffstat (limited to 'inc')
-rw-r--r--inc/config.php12
1 files changed, 6 insertions, 6 deletions
diff --git a/inc/config.php b/inc/config.php
index 750782bc..b6c510a7 100644
--- a/inc/config.php
+++ b/inc/config.php
@@ -1291,14 +1291,14 @@
* =============
*/
- // Whether or not to use the API, disabled by default.
+ // Whether or not to enable the 4chan-compatible API, disabled by default. See
+ // https://github.com/4chan/4chan-API for API specification.
$config['api']['enabled'] = false;
- // Extra fields in to be shown in the array that are not 4chan API compatible.
- // You canget these by taking a look at the schema for posts_ tables. The array should be formatted as $db_name => $translated_name.
- // For example:
-
- // $config['api']['extra_fields'] = array('body_nomarkup'=>'com_nomarkup');
+ // Extra fields in to be shown in the array that are not in the 4chan-API. You can get these by taking a
+ // look at the schema for posts_ tables. The array should be formatted as $db_column => $translated_name.
+ // Example: Adding the pre-markup post body to the API as "com_nomarkup".
+ // $config['api']['extra_fields'] = array('body_nomarkup' => 'com_nomarkup');
/*
* ====================