Skip to content

CLAUDE.md

Latest commit

 

History

History
37 lines (22 loc) · 1.34 KB

CLAUDE.md

File metadata and controls

37 lines (22 loc) · 1.34 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Build & Test Commands

mix compile                        # Compile
mix test                           # Run all tests (~40s, 607 tests)
mix format                         # Format code
mix dialyzer                       # Static type analysis
mix docs                           # Generate documentation

mix test requires the current working directory to be the project root directory.

Architecture

Collation is an Elixir implementation of the Unicode Collation Algorithm, based upon the modified CLDR collation rules.

Function documentation

All public functions should have a standard template format:

  • A short description of the function's purpose.

  • A section with heading ### Arguments in which each argument is named and described in a bullet list.

  • A section with heading ### Options if the last function argument is a keyword list. Each option to be named and described.

  • A section with heading ### Returns that describes the alternative return values from the function.

  • A section with heading ### Examples that includes one or two doctest examples.

  • A blank line before the closing """.

All bulleted list items in docstrings must end with a period and have a blank line between each list item.