sqlite3_index_info doc typos

(1) By Roger Binns (rogerbinns) on 2023-01-14 18:00:33 [source]

For the doc page https://www.sqlite.org/c3ref/index_info.html

The doc mentions idxPtr which should be idxStr

It also ends abruptly mentioning 3 methods but not saying why.

Roger

(2) By Larry Brasfield (larrybr) on 2023-01-14 19:16:33 in reply to 1 [link] [source]

Thanks, Roger. The typos are fixed.

The "abrupt" end without mentioning more methods is not fixed. I can see why it might look abrupt, but that is not where the methods are described. The section in question is about how some methods use the sqlite3_index_info struct, so it ends with that done.

I'm not sure how to avoid this appearance of incompleteness.

(3) By Roger Binns (rogerbinns) on 2023-01-14 23:43:21 in reply to 2 [link] [source]

Thanks for the fix.

Looking at other pages from the Objects section I see that some list constructors, destructors, and methods. On pages where all exist it is clear what is happening. A minor heading of "Used by" or "See also" would have helped me. Or even a <hr> tag as a separator.

Roger

(4) By Larry Brasfield (larrybr) on 2023-01-16 20:20:04 in reply to 3 [link] [source]

I've made a minor change to clarify the limited meaning of the method(s) list. I agree that, as it was, it could be taken as you interpreted it.