SQLite Forum

Trivial typo in the documentation
Login

Trivial typo in the documentation

(1) By Gisbert (gisbert) on 2020-03-30 13:18:33 [link] [source]

unlock_notify.html contains a spurious backspace (x08, ^H) before "Atomically releases..." (and before that, a spurious "a"). This may throw off post processors of the documentation. Thanks to anonymous for spotting that something is amiss.

(2) By Gisbert (gisbert) on 2020-04-06 18:37:00 in reply to 1 [link] [source]

There are also a number of HTML entities in the doc files with the terminating semicolon missing. (Browsers are usually pretty good at covering up for such minor typos, so this is more of an aesthetic issue, cleanliness is next to codeliness.)

Misspelled entity present in file(s)...
'&#195"' fts5.html
'&#91<' json1.html printf.html
'&#93 ' opcode.html
'&#93"' json1.html
'&#93.' opcode.html
'&#93<' changes.html vtab.html
'&#93=' opcode.html
'&#94"' oldnews.html
'&gt)' fts3.html
'&lt<' changes.html
'&nbsp&' nulls.html
'&nbspc' cli.html
'&sup1.' onefile.html
'&sup1' appfunc.html and numerous other files
'&sup2)' limits.html
'&sup2' appfunc.html and numerous other files
'&sup3' appfunc.html and numerous other files

(3) By Richard Hipp (drh) on 2020-04-06 19:05:13 in reply to 2 [link] [source]

Please rerun your analysis tool and let us know if there are any other instances of improperly terminated HTML entities lurking in the documentation after the most recent round of fixes.

(4) By Gisbert (gisbert) on 2020-04-07 19:26:05 in reply to 3 [source]

You're incredible! That message came within half an hour after my post.

Thank you for all that incredible struggle for perfection, benefitting all of us!

Will re-run the check, of course.

(5) By Gisbert (gisbert) on 2020-04-07 20:13:39 in reply to 3 [link] [source]

Yes, in fact some have escaped the cleaning process, viz., multiple instances of &sup1 and &sup2 and &sup3.

They seem to come up always together, and the affected files are, based on the HTML files online at sqlite.org as of now (2020-04-07 20:00 UTC):

appfunc.html
c3ref\constlist.html
c3ref\context.html
c3ref\funclist.html
c3ref\objlist.html
c3ref\sqlite3.html
c3ref\stmt.html
c3ref\str.html
c3ref\value.html
capi3ref.html
lang.html
lang_aggfunc.html
lang_corefunc.html
pragma.html
rescode.html
session.html
session\changeset_iter.html
session\constlist.html
session\funclist.html
session\objlist.html
session\session.html
syntax.html

Thank you for caring!