README.md describes modes and the schema as they were, not as they are #119

Closed
opened 2026-10-08 07:33:11 +02:00 by clawbot · 1 comment
Collaborator

README.md no longer matches the code on next:

  • The MODE section says "Mode changes (setting/unsetting modes) are not yet implemented. Currently only query is supported." Channel modes and user modes can both be set now (the tier 1 and tier 2 channel modes, and user modes +w and -o from #87), with replies and errors the section does not describe.
  • The column tables under "Schema" are behind internal/db/schema/001_initial.sql: for example sessions lacks is_wallops, and channel_members lacks its operator and voice flags. Other tables may be missing or incomplete too.

Definition of done

  1. Every table and column in 001_initial.sql appears in the README's schema section with its type and a one-line description, and nothing there is absent from the schema.
  2. The MODE section describes what the code does today on both the HTTP API and the IRC listener: channel and user mode queries and changes, the mode letters accepted, and the error replies.
  3. Every sentence this PR adds or changes is true of the code, and the findings of the reviews already posted on the PR are fixed; nothing is added that the code does not do. A contradiction found later in a part of README.md this PR does not touch goes to a new issue rather than holding this one.
  4. Markdown formatted with make fmt. One reviewed PR against next.

(Corrected 2026-10-08: item 3 first asked for every contradiction anywhere in README.md, which had no end.)

Model: opus-5-5

`README.md` no longer matches the code on `next`: - The `MODE` section says "Mode changes (setting/unsetting modes) are not yet implemented. Currently only query is supported." Channel modes and user modes can both be set now (the tier 1 and tier 2 channel modes, and user modes `+w` and `-o` from https://git.eeqj.de/sneak/neoirc/issues/87), with replies and errors the section does not describe. - The column tables under "Schema" are behind `internal/db/schema/001_initial.sql`: for example `sessions` lacks `is_wallops`, and `channel_members` lacks its operator and voice flags. Other tables may be missing or incomplete too. ## Definition of done 1. Every table and column in `001_initial.sql` appears in the README's schema section with its type and a one-line description, and nothing there is absent from the schema. 2. The `MODE` section describes what the code does today on both the HTTP API and the IRC listener: channel and user mode queries and changes, the mode letters accepted, and the error replies. 3. Every sentence this PR adds or changes is true of the code, and the findings of the reviews already posted on the PR are fixed; nothing is added that the code does not do. A contradiction found later in a part of `README.md` this PR does not touch goes to a new issue rather than holding this one. 4. Markdown formatted with `make fmt`. One reviewed PR against `next`. (Corrected 2026-10-08: item 3 first asked for every contradiction anywhere in `README.md`, which had no end.) Model: opus-5-5
clawbot self-assigned this 2026-10-08 07:33:12 +02:00
Author
Collaborator

#120 brings README.md in line with the code on next: the MODE section now covers channel and user mode queries and changes on both the HTTP API and the IRC listener, the schema section lists every table and column in 001_initial.sql, and every other statement the code contradicts is corrected. Code bugs found along the way are listed in the PR and left alone.

Model: opus-5-5

https://git.eeqj.de/sneak/neoirc/pulls/120 brings `README.md` in line with the code on `next`: the `MODE` section now covers channel and user mode queries and changes on both the HTTP API and the IRC listener, the schema section lists every table and column in `001_initial.sql`, and every other statement the code contradicts is corrected. Code bugs found along the way are listed in the PR and left alone. Model: opus-5-5
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/neoirc#119