Tiny Tiny RSS: Community

Documentation errors


#1

The API documentation has errors in spots (presumably out of date information), chiefly:

  • getCounters is listed twice, and in both cases makes mention of the output_mode parameter removed in 2013
  • getHeadlines mentions an updated view mode which seems not to exist, and does not mention has_note or published, which do exist

There’s also no mention of using strings for feed_id to return results by tag, but I presume this is an intentionally undocumented feature.

Additionally, the “Generated feeds” document’s formatting is pretty broken in a few places, evidently a victim of imperfect conversion when moving to Gogs.

A patch for both files follows:

 ApiReference.md   | 25 +------------------------
 GeneratedFeeds.md | 24 ++++++++++++------------
 2 files changed, 13 insertions(+), 36 deletions(-)

diff --git a/ApiReference.md b/ApiReference.md
index f5fab65..9889aea 100644
--- a/ApiReference.md
+++ b/ApiReference.md
@@ -144,8 +144,6 @@ Returns an integer value of currently unread articles.
 
 Returns JSON-encoded counter information. Requires version:1.5.0.
 
-* output\_mode (string, default: flc) - what kind of information to return (f - feeds, l - labels, c - categories, t - tags)
-
 ### getFeeds
 
 Returns JSON-encoded list of feeds. The list includes category id,
@@ -213,7 +211,7 @@ Parameters:
 -   show\_excerpt (bool) - include article excerpt in the output
 -   show\_content (bool) - include full article text in the output
 -   view\_mode (string = all\_articles, unread, adaptive, marked,
-    updated)
+    published, has_note)
 -   include\_attachments (bool) - include article attachments (e.g.
     enclosures) **requires version:1.5.3**
 -   since\_id (integer) - only return articles with id greater than
@@ -351,27 +349,6 @@ Returns status-message if the operation has been completed.
 {"status":"OK"}
 \`\`\`
 
-### getCounters
-
-Required version: version:1.5.0
-
-Returns a list of unread article counts for specified feed groups.
-
-Parameters:
-
--   output\_mode (string) - Feed groups to return counters for
-
-Output mode is a character string, comprising several letters (defaults
-to “flc”):
-
--   f - actual feeds
--   l - labels
--   c - categories
--   t - tags
-
-Several global counters are returned as well, those can’t be disabled
-with output\_mode.
-
 ### getLabels (since API level 1)
 
 Returns list of configured labels, as an array of label objects:
diff --git a/GeneratedFeeds.md b/GeneratedFeeds.md
index 93af114..338dc15 100644
--- a/GeneratedFeeds.md
+++ b/GeneratedFeeds.md
@@ -57,19 +57,19 @@ Optional parameters:
 
 Special feed IDs:
 
--   ~~1~~ Starred articles
--   ~~2~~ Published articles
--   ~~3~~ Fresh articles
--   ~~4~~ All articles
--   0 - Archived articles
-
-Feed IDs \< ~~10 are considered Labels.
-\
+-   -1 - Starred articles
+-   -2 - Published articles
+-   -3 - Fresh articles
+-   -4 - All articles
+-    0 - Archived articles
+
+Feed IDs \< -10 are considered Labels.
+
 Special category IDs (is\_cat=1):
-\
-\* 0~~ Uncategorized\
-\* ~~1~~ Special category (includes Starred, Published, etc.)\
-\* ~~2~~ Labels category (includes your labels)
+
+-  0 - Uncategorized
+- -1 - Special category (includes Starred, Published, etc.)\
+- -2 - Labels category (includes your labels)
 
 View mode values:
 

#2

thanks but i don’t know how to apply a patch off the forum. can you maybe clone the wiki repo on gogs and do a pull request or something?


#3

I tried. One cannot perform a pull request on a wiki, as far as I can tell.


#4

damn, i guess gogs doesn’t allow it. can you email me the diff?