ashvardanian / ashvardanian/SmashTable

Document errors via `@retval`

Open
#8 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
49
Forks
4
Avg merge
2d 1h
Merged PRs (30d)
2

Description

Besides existing `@return` doxygen tags for return types/objects, in some cases, we should enumerate possible values and errors with `@retval`.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing C++ Doxygen comments that use @return tags and identify cases where possible values or errors are documented. Add @retval entries for those applicable cases, then verify that the affected documentation clearly enumerates the returned values and errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.