Skip to content

Rewrite documentation for professional tone#2

Merged
twinn merged 1 commit intomainfrom
docs-rewrite
Apr 10, 2026
Merged

Rewrite documentation for professional tone#2
twinn merged 1 commit intomainfrom
docs-rewrite

Conversation

@twinn
Copy link
Copy Markdown
Owner

@twinn twinn commented Apr 10, 2026

Summary

  • Aligns all moduledocs, @doc strings, and README with the declarative third-person style used by Elixir's hexdocs
  • Updates stale references to "pg group" and "consistent hashing" to reflect current PgRegistry and rendezvous hashing implementation
  • Converts imperative verb forms ("Insert a job") to third-person ("Inserts a job") per Elixir convention
  • Removes promotional language from README

Test plan

  • mix precommit — format, credo, 82 tests, 0 failures

Align moduledocs, @doc strings, and README with the declarative
third-person style used by Elixir's hexdocs. Update stale references
to pg groups and consistent hashing to reflect the current PgRegistry
and rendezvous hashing implementation.
@twinn twinn merged commit bd1df11 into main Apr 10, 2026
1 check passed
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