Improve docs 2 - #36
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR focuses on improving Cake’s documentation by clarifying XOR semantics across adapters, refreshing README links, and adding a new Markdown-based API reference under docs/api/.
Changes:
- Clarifies
xor_wheredocumentation to state that Cake always emulates “exactly-one” XOR viaOR/AND/NOT, and points users towhere.xor_parityfor MariaDB/MySQL parity XOR. - Updates README HexDocs links and removes the large “Library Design” diagram section from the README.
- Adds a new API reference documentation set under
docs/api/*and registers a new “DIAGRAMS” documentation page ingleam.toml.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/cake/update.gleam | Updates xor_where doc comment to clarify adapter behavior and direct users to xor_parity where appropriate. |
| src/cake/select.gleam | Updates xor_where doc comment with the same clarified XOR-emulation guidance. |
| src/cake/delete.gleam | Updates xor_where doc comment with the same clarified XOR-emulation guidance. |
| README.md | Updates HexDocs URL and removes the in-README “Library Design” diagram section. |
| gleam.toml | Adds a “DIAGRAMS” docs page entry (currently pointing at docs/diagrams.md). |
| docs/api.md | Adds a top-level API docs placeholder page. |
| docs/api/index.md | Adds an API reference landing page and module index. |
| docs/api/select.md | Adds Markdown API reference for cake/select. |
| docs/api/insert.md | Adds Markdown API reference for cake/insert. |
| docs/api/update.md | Adds Markdown API reference for cake/update. |
| docs/api/delete.md | Adds Markdown API reference for cake/delete. |
| docs/api/where.md | Adds Markdown API reference for cake/where, including xor vs xor_parity explanation. |
| docs/api/join.md | Adds Markdown API reference for cake/join (includes some exclusive-join wording issues). |
| docs/api/fragment.md | Adds Markdown API reference for cake/fragment, including safety guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.