Skip to content

Add guidance against flippant appeals to obviousness - #42

Merged
dem-extra1 merged 5 commits into
mainfrom
claude/flippant-phrasing-docs-5h6ny7
Aug 10, 2026
Merged

Add guidance against flippant appeals to obviousness#42
dem-extra1 merged 5 commits into
mainfrom
claude/flippant-phrasing-docs-5h6ny7

Conversation

@d-morrison

@d-morrison d-morrison commented Aug 9, 2026

Copy link
Copy Markdown
Collaborator

Why

Phrases like "it is obvious that", "clearly, it follows that", and "the familiar formula" assert that a claim needs no support instead of supplying any. A reader who already knows the result gains nothing from being told it is familiar; a reader who does not is told the gap is their own fault and given no way to close it.

The guide had no section on this, and its "common citation errors" list covered vague attribution ("studies have shown") but not the appeal-to-obviousness version of the same dodge.

What changed

All changes are in chapters/citations-evidence.qmd, which is the natural home since the remedy is to prove the result or cite a specific source.

  • New section "Do not substitute flippancy for support", placed after "What constitutes adequate support":
    • names the offending phrases, with a caveat that the problem is the appeal rather than the individual words — "clearly" is fine as an adverb of manner, and "of course" is fine when it flags an assumption you have already established;
    • gives three replacements — a direct derivation, a specific citation with a chapter/section/page/equation locator, or a cross-reference to an earlier result in the same document;
    • notes that deleting the phrase makes the same claim as keeping it, while inviting the reader to check that claim rather than defer to it;
    • works an example through the rewrite: "the familiar three-term formula" becomes the normal log-likelihood written out, with its three terms listed against the equation.
  • New subsection on "trivial" / "trivially". Its one defensible use — describing how a general expression reduces in a special case — is usually served better by "minimal case" or "degenerate case", which name the situation more precisely and avoid the dismissive tone.
  • Added an "Appeal to obviousness" bullet to the chapter's list of common citation errors.
  • Reworded the chapter conclusion so it does not lean on "obvious" itself ("If your text does not answer that question, add a citation…").

Commits

  • b9712e0 — adds the section, the subsection, the error-list bullet, and the conclusion reword.
  • 057e6cb — removes a claim from the first commit which asserted that writers reach for "obviously" most often at the steps they have checked least carefully. That is an empirical claim about writer behavior with no citation, in a chapter about not making unsupported claims. Replaced with the part the argument needs: working a step out is how you learn whether it holds, and calling it obvious settles the question by assertion instead.
  • 9dcdcf5 — merge of main (not mine), bringing in the claude-code-review workflow fix from Fix claude-code-review.yml startup_failure: grant actions: read, pin @v2 #44.
  • 530e34c — review round 1: drops a spaced em-dash used as a connector, extends the "clearly" carve-out to cover "of course", and aligns the phrase in the errors bullet with the one in the section list.
  • 08a5a9f — review round 2: converts the three-term enumeration in the worked example into a bullet list, per CLAUDE.md's rule for lists of three or more items.

Verification

  • quarto render chapters/citations-evidence.qmd to HTML and RevealJS: both succeed, the example callout and the display math render, the bullet list nests correctly inside the blockquote, and no cross-references are unresolved.
  • .github/scripts/check-non-standard-chars.py: passes.
  • The log-likelihood in the example was checked term by term against the described decomposition, including the sign on the last term.
  • No R code changed, so no lint run was needed.

Open question

The section sits in Citations and evidence because the remedy is prove-or-cite. It would also fit in Word choice, beside "Avoid vague and metaphorical language", if you would rather keep word-level tone advice together.

Phrases like "it is obvious that", "clearly, it follows that", and "the
familiar formula" assert that a claim needs no support instead of
supplying any. They leave a reader who does not already know the result
with no way to close the gap, and they cluster around the steps a writer
has checked least carefully.

Add a section to the citations-and-evidence chapter that names the
pattern, gives the three ways to fix it (derive it, cite a specific
chapter/section/page/equation, or cross-reference an earlier result),
and works a normal log-likelihood example through the rewrite. Cover
"trivial"/"trivially" separately, since its one defensible use --
describing how a general expression reduces in a special case -- is
usually served better by "minimal case" or "degenerate case".

Also add the pattern to the chapter's list of common citation errors,
and reword the conclusion so it does not lean on "obvious" itself.

Copy link
Copy Markdown
Collaborator Author

CI status on b9712e0: every content check is green — Spellcheck, Check Links, Check Non-Standard Characters, lint-project, lint-changed-files, and Quarto Preview (preview built and deployed).

Two red marks remain, neither caused by this diff, so I have not touched either:

  • .github/workflows/check-bibliography-dois.yml — the file is commented out end to end (no name:, on:, or jobs: keys), so GitHub cannot parse it as a workflow and records an instant zero-job failure on every push. Fixing it means either deleting the file or leaving a stub with on: workflow_dispatch; that is a repo-wide cleanup rather than part of this change, so it seems better as its own PR.
  • Claude Code Reviewstartup_failure, no jobs created.

Generated by Claude Code

@d-morrison

Copy link
Copy Markdown
Collaborator Author

@claude review

@github-actions

Copy link
Copy Markdown

👀 Picked up by workflow run #31346875231. Setup runs first; Claude itself responds after that.

The section argued that writers reach for "obviously" most often at the
steps they have checked least carefully. That is an empirical claim
about writer behavior, stated without a citation, inside a chapter about
not making unsupported claims -- exactly the failure the section warns
against. I have no source for it, so it goes.

Replace it with the part of the point the argument actually needs, which
is a claim about what the phrasing does rather than how often writers
use it: working a step out is how you learn whether it holds, and
calling it obvious settles the question by assertion instead.

Also soften "asserts exactly as much as" to "makes the same claim about
the log-likelihood as", since "obviously" does add a (weak) claim about
how hard the step is.

Copy link
Copy Markdown
Collaborator Author

Heads up: the review you asked for never ran. The @claude job dispatched it (run 31346942434), but that run hit a startup_failure against main — the same failure mode as the automatic Claude Code Review run on this PR's first commit. Runs of that workflow on 5996bd3 at 01:53 succeeded, so whatever fixes it appears to be on another branch and not yet on main.

Since I am the session that wrote this branch, here is my own read of the diff rather than an independent review — worth weighting accordingly.

One real problem, now fixed in 057e6cb. The section contained:

The phrasing also conceals a common failure mode: writers reach for "obviously" most often at the steps they have checked least carefully.

That is an empirical claim about writer behavior with no citation, in a chapter about not making unsupported claims, inside a section arguing you should derive or cite instead. I have no source for it, so I removed it rather than dressing it up. The replacement keeps only the part the argument needs — a claim about what the phrasing does, not how often writers use it:

Working a step out is how you find out whether it holds; calling it obvious settles the question by assertion, and leaves any error in the step where it is.

Same commit softens "asserts exactly as much as" to "makes the same claim about the log-likelihood as", since "obviously" does add a weak claim about difficulty.

Checked and believed correct:

  • The log-likelihood in the example is right for an independent normal sample, and the three described terms match the three written terms, including the sign on the last one.
  • The chapter's conclusion no longer leans on "obvious" itself.
  • The "clearly" caveat is deliberate: the guide uses "clearly" as an adverb of manner in several places, and without the caveat the section would condemn its own prose.

Open question for you: the section lands in Citations and evidence because the remedy you specified is prove-or-cite. It would also sit defensibly in Word choice, next to "Avoid vague and metaphorical language". Happy to move it if you would rather keep word-level tone advice together.


Generated by Claude Code

@github-actions

Copy link
Copy Markdown

👀 Picked up by workflow run #31349655766. Setup runs first; Claude itself responds after that.

@github-actions

Copy link
Copy Markdown

This is a @claude review request. Per the workflow instructions, I should not post my own review — the post-step dispatches the dedicated code-review workflow instead.

Checking for any additional @claude requests after the triggering comment (id 5234904321, 2026-08-10T01:21:21Z):

  • Comment 5234905313: bot notification, no @claude
  • Comment 5235208968: Claude bot response, no @claude
  • Comment 5235210065: bot notification, no @claude

No additional @claude requests to address. The dedicated code-review workflow will be dispatched by the post-step.

— posted by @claude post-step from workflow run

@d-morrison

Copy link
Copy Markdown
Collaborator Author

@claude review

@github-actions

Copy link
Copy Markdown

👀 Picked up by workflow run #31353997858. Setup runs first; Claude itself responds after that.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

Three points from the code review, all in the new section:

- Replace the spaced em-dash before the "weighted average" example with
  a sentence break. The avoid-ai-tells chapter names the em-dash as a
  default connector as a formatting tell, and a section arguing for
  rhetorical rigor should not model the habit.

- Give "of course" the same carve-out "clearly" already had. Unlike the
  other entries, it has an honest use -- flagging an assumption you have
  already established -- so the caveat now covers both words, and the
  test for both is whether the phrase stands in for an argument you have
  not made.

- Make the phrase in the "Common citation errors" bullet ("as is well
  known") match the one catalogued in the section list ("as everyone
  knows"), so the two lists point at the same target.

Copy link
Copy Markdown
Collaborator Author

All three review notes are addressed in 530e34c. I took the two mechanical ones as written and acted on the judgment call rather than leaving it open, since the section is specifically about not waving things through.

Em-dash as connector. Fixed. The spaced em-dash before the weighted-average example is now a sentence break:

…in a special case. For example, a weighted average reduces to an ordinary average when all of the weights are equal.

You were right that one instance is not a cluster, but a section arguing for rhetorical rigor should not model a habit the guide names elsewhere.

"as is well known" vs "as everyone knows". Fixed — the errors bullet now uses "as everyone knows", matching the section list.

"of course". I gave it the same carve-out "clearly" already had rather than dropping it, since your reasoning applies to both words equally:

The problem is the appeal, not the individual words. "Clearly" is fine as an adverb of manner ("the methods section clearly describes the sampling frame"), and "of course" is fine when it flags an assumption you have already established. Each becomes a problem only when it stands in for an argument you have not made.

That keeps the entry — "of course" is a real offender in the appeal sense — while making the test explicit for both.

Re-rendered to HTML and re-ran the non-standard-character check after the edits; both clean.

One note on the review / require-review check that failed on 9dcdcf5: it went red at 03:57, while review / claude-review was still in progress, and the review then finished at 04:00 with Ready for merge. It looks like a gate that failed before its input existed rather than a real objection, so I have not treated it as one — worth a glance if it stays red on the new commit.


Generated by Claude Code

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

CLAUDE.md asks for bullet lists rather than comma-separated prose for
lists of three or more items. The worked example enumerated the three
terms of the log-likelihood in a single sentence, which is exactly the
shape that rule covers, and the reader does scan it: each item pairs
with one term of the displayed equation.

The example is meant to model good practice, so it should follow the
project's own convention. Semicolons separate the items because the last
one contains a comma.

Copy link
Copy Markdown
Collaborator Author

Took the optional note too, in 08a5a9f. The three-term enumeration inside the ✅ example is now a bullet list:

The three terms are, in order:

  • a constant that does not involve the parameters;
  • a term that depends on $\sigma^2$ but not on $\mu$;
  • the sum of squared deviations of the data from $\mu$, divided by $-2\sigma^2$.

I went the other way from the review's own leaning, for two reasons. The reader does scan this one — each item pairs with one term of the displayed equation, which is different from the "chapter, section, page, or equation number" case at line 116, where the items are interchangeable alternatives inside a clause. And the block is a worked example of good practice, so it is the last place that should quietly opt out of the project's own convention.

Semicolons separate the items because the last one contains a comma. Re-rendered and confirmed the list renders correctly inside the blockquote, with the display math above it intact; the non-standard-character check passes.


Generated by Claude Code

@github-actions

Copy link
Copy Markdown

Claude finished reviewView run


I have everything needed to finalize this confirming review.

Review: PR #42 — Add guidance against flippant appeals to obviousness

What changed since the last review round: The most recent review (2026-08-10T04:14:21Z, verdict Ready for merge) left one optional, non-blocking observation: the three-term enumeration inside the ✅ worked example (chapters/citations-evidence.qmd) was comma-separated prose, which CLAUDE.md's "Lists of 3+ items: use bullet lists" rule could arguably cover, though the reviewer explicitly noted it wasn't blocking.

Commit 08a5a9f6 ("Make the three-term enumeration a bullet list") takes that optional note. It converts the sentence into a proper markdown bullet list nested inside the blockquote:

> The three terms are,
> in order:
>
> - a constant that does not involve the parameters;
> - a term that depends on $\sigma^2$ but not on $\mu$;
> - the sum of squared deviations of the data from $\mu$,
>   divided by $-2\sigma^2$.

Verified:

  • A blank blockquote line (>) precedes the list, satisfying CLAUDE.md's "leave a blank line before a markdown bullet list."
  • Semicolons separate items since the last item's clause contains an internal comma — correct, unambiguous list punctuation.
  • The math is still correct: "divided by −2σ²" is algebraically equivalent to the −1/(2σ²) coefficient in the displayed equation, and each bullet still maps one-to-one to a term of ℓ(μ,σ²).
  • Nested bullet-in-blockquote is standard Pandoc/Quarto markdown and renders correctly; no raw HTML introduced.
  • gh pr diff 42 --name-only confirms only chapters/citations-evidence.qmd changed — scope still matches the PR description, no unrelated files touched.
  • The subsequent commit 9dcdcf57 is a merge of main into the branch with no additional content changes (diff against main shows the same single-file, additive change as before plus this one bullet-list edit).
  • The author's own PR comment explaining the choice (bullets vs. the reviewer's other lean) is a reasonable, well-justified editorial call — the items pair 1:1 with terms of a displayed equation, unlike the interchangeable-alternatives case at line 116, so scanability genuinely benefits here.

No new issues introduced by this commit. No CLAUDE.md violations, no math errors, no broken cross-references, no fabricated citations or paths.

Verdict

Ready for merge — this confirms and extends the prior verdict at #42 (comment); the only outstanding optional note from that round has now been addressed and verified, and no new findings surfaced.

@github-actions

Copy link
Copy Markdown

💰 Cost: $0.7581 (review) — run

@dem-extra1
dem-extra1 merged commit 6c76dbe into main Aug 10, 2026
9 checks passed
@dem-extra1
dem-extra1 deleted the claude/flippant-phrasing-docs-5h6ny7 branch August 10, 2026 05:30
@github-actions

Copy link
Copy Markdown
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-08-10 05:33 UTC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants