asp/keep
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Fully document db module functions with examples and details

Browse Source 
Co-authored-by: aider (openai/andrew/openrouter/sonoma-sky-alpha) <aider@aider.chat>
This commit is contained in:
Andrew Phillips
2025-09-10 16:05:20 -03:00
parent 11ec6cf01e
commit 9e11756d4a
2 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
PLAN.md
View File

@@ -24,20 +24,20 @@ Private helpers (e.g., internal `fn` without `pub`) are not flagged, as they don
- Overall: The file has some inline comments but lacks comprehensive rustdoc for the public API.
2. **src/db.rs** [DONE]
- `Item`, `Tag`, and `Meta` structs: Partial docs (fields documented, but missing overall struct description or examples).
- `open()` function: Good doc, but missing error examples.
- `insert_item()` function: Partial (missing full error details).
- `create_item()` function: Partial.
- `add_tag()` and `add_meta()` functions: No docs.
- `update_item()` and `delete_item()` functions: No docs.
- `query_delete_meta()` and `query_upsert_meta()` functions: No docs.
- `store_meta()` function: Partial.
- `insert_tag()` and `delete_item_tags()` functions: No docs.
- `set_item_tags()` function: Partial.
- `query_all_items()` and `query_tagged_items()` functions: Partial.
- `get_items()` function: No doc.
- `get_items_matching()` function: Partial.
- `get_item_matching()` function: Partial.
- `Item`, `Tag`, and `Meta` structs: [DONE]
- `open()` function: [DONE]
- `insert_item()` function: [DONE]
- `create_item()` function: [DONE]
- `add_tag()` and `add_meta()` functions: [DONE]
- `update_item()` and `delete_item()` functions: [DONE]
- `query_delete_meta()` and `query_upsert_meta()` functions: [DONE]
- `store_meta()` function: [DONE]
- `insert_tag()` and `delete_item_tags()` functions: [DONE]
- `set_item_tags()` function: [DONE]
- `query_all_items()` and `query_tagged_items()` functions: [DONE]
- `get_items()` function: [DONE]
- `get_items_matching()` function: [DONE]
- `get_item_matching()` function: [DONE]
- `get_item()` and `get_item_last()` functions: Partial.
- `get_item_tags()` and `get_item_meta()` functions: Partial.
- `get_item_meta_name()` and `get_item_meta_value()` functions: Partial.