Reword and give examples in digest.base64_encode
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Reword and give examples in digest.base64_encode
https://www.tarantool.io/en/doc/latest/reference/reference_lua/digest/#digest-base64-encode
- Take a usual string which converts to base64 with
+and/ - give examples of output without options and with each of the options
<…> or line feed, and may contain
‘-‘ or ‘_’ instead of ‘+’ or ‘/’ |for positions 62 and 63 in the index
table|.Options may be true or false, the default value is false.
For<…>
https://www.tarantool.io/en/doc/latest/reference/reference_lua/digest/#digest-base64-encode
It seems, it refers to the implementation details, which are not available for a user.
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
Open the linked digest.base64_encode reference page and review the current wording and option descriptions. Use a normal string whose Base64 output contains '+' and '/', then document the output with no options and with each option. Done when the page explains user-visible behavior without implementation-specific wording and includes all requested examples.
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
- Clearly specified
- Newbie friendliness
- 45/100