docs: restore README.md lost in Floor Raise campaign - #6
Conversation
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ac247f63db
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - `divide(a, b)` - Division | ||
| - `modulo(a, b)` - Modulo (integer operation) |
There was a problem hiding this comment.
The README now advertises functions like divide/2, modulo/2, greater_than/2, not_equal/2, and greater_equal/2, but these are not defined in the current library modules (lib/arithmetic.ex and lib/comparison.ex), so users following this documentation will hit UndefinedFunctionError. Please either remove these entries or implement the APIs before documenting them.
Useful? React with 👍 / 👎.
| ```elixir | ||
| def deps do | ||
| [ | ||
| {:polyglot_formalisms, "~> 0.2.0"} |
There was a problem hiding this comment.
The installation example pins {:polyglot_formalisms, "~> 0.2.0"} while mix.exs declares the project as version 0.3.0; this mismatch encourages consumers to install an older release than the codebase being documented and can lead to API/docs drift for new users.
Useful? React with 👍 / 👎.
| This implementation follows BEAM/Erlang semantics: | ||
|
|
||
| ### Float Operations | ||
| - Division by zero returns `Infinity` or `-Infinity` |
There was a problem hiding this comment.
The behavioral section claims division by zero returns Infinity/-Infinity, but in Elixir/BEAM 1.0 / 0.0 raises ArithmeticError; documenting the opposite behavior can cause incorrect exception handling assumptions in downstream code.
Useful? React with 👍 / 👎.
1 participant
Summary
Co-Authored-By: Claude Opus 4.6 (1M context) noreply@anthropic.com