apache / apache/arrow-cookbook
Use `ARROW_RETURN_NOT_OK` (and friends) instead of `ASSERT_OK` (and friends) in recipes
Open
cpp
- Dominant language
- C++
- Stars
- 108
- Forks
- 49
- Avg merge
- 2h 14m
- Merged PRs (30d)
- 1
Description
Recipes should show how the code will be used in the wild. `ASSERT_OK` is tailored for tests. We could probably do this by putting recipes in their own function (possibly a part of the macro?) and then asserting the function returns ok.
Contributor guide
Research direction
Start by locating the cookbook recipes that use ASSERT_OK and related test macros, then compare them with the ARROW_RETURN_NOT_OK family. Clarify whether recipes should move into their own function or use another structure before changing examples. Done means the recipes demonstrate production-style status handling rather than test-only assertions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100