Skip to content

Correct messages and docs that described things the library does not do - #40

Merged
mdfarhankc merged 1 commit into
mainfrom
fix/docs-and-messages
Sep 21, 2026
Merged

mdfarhankc merged 1 commit into
mainfrom
fix/docs-and-messages

Conversation

@mdfarhankc

Copy link
Copy Markdown
Owner

Summary

Wording and documentation fixes only. No behaviour changes.

  • /register no longer claims to have sent a verification email. It answered "a verification email has been sent", but registration never emits send_verification_email, so users waited for mail that was not coming. It now says "If this email isn't already registered, the account has been created." The docs gain a recipe for sending one from the after_register hook.
  • The auto-link refusal no longer points at a missing endpoint. It told users to link the provider "from account settings", which no route supports. The message is internal to OAuthProviderError; the HTTP response is unchanged.
  • The Agent Skill described things that do not exist. It listed eight admin routes the library has never shipped, said admin routes accept require_role("admin") when they require a superuser, and described an OAuth callback that links through the caller's session.

Compatibility

The /register response text changes. Anything asserting on the old string needs updating; the status code and shape are the same.

Checks

ruff, ruff format, mypy --strict, pytest (514 passed, 9 skipped), mkdocs build --strict.

/register answered "a verification email has been sent" while registration
never emits send_verification_email, so users waited for mail that was not
coming. It now says only what is true, and the docs show how to send one
from the after_register hook.

The refusal raised when auto-linking an unverified email told users to link
the provider "from account settings", an endpoint that does not exist.

The Agent Skill listed eight admin routes the library has never shipped,
claimed admin routes accept require_role("admin") when they require a
superuser, and described an OAuth callback that links through the caller's
session. Agents following it would have built against 404s.

No behaviour changes.
@coderabbitai

coderabbitai Bot commented Sep 21, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 9bfd8737-553c-454b-a8e5-be269e57650c


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mdfarhankc
mdfarhankc merged commit ba7dc45 into main Sep 21, 2026
7 checks passed
@mdfarhankc
mdfarhankc deleted the fix/docs-and-messages branch September 21, 2026 17:19
@mdfarhankc mdfarhankc mentioned this pull request Sep 21, 2026
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.

1 participant