[5pt] Fix digest module
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Info
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/digest/
What's wrong?
The description of the functions on this page does not match our usual template. I think we need to fix this.
Also, @veod32 suggests adding an external link to the doc or any other reference about this library (line 310):
The guava function uses the
Consistent Hashing <https://en.wikipedia.org/wiki/Consistent_hashing>_ algorithm of the Google guava library.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the digest module page at the linked root document and compare its function descriptions with the project's usual documentation template. Inspect line 310 for the suggested external reference; done means the descriptions follow the template and the relevant library reference link is included.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100