Document parameters given to store_tokens callback
Open
enhancement
- Dominant language
- Python
- Stars
- 459
- Forks
- 223
- Avg merge
- 8h 57m
- Merged PRs (30d)
- 13
Description
### Is your feature request related to a problem? Please describe.
I couldn't find this documented anywhere and had to dig into the source to find its arguments
### Describe the solution you'd like
Document it in the relevant docstrings and the mentions in the README
### Describe alternatives you've considered
n/a
### Additional context
n/a
Contributor guide
Research direction
Locate the store_tokens callback definition and read its current docstring and the README mentions of the callback. Document the callback parameters consistently in those locations, then verify that the documented arguments match the source implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100