Deprecate encoder= calling parameter in all APIs
Open
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 1.2k
- Forks
- 267
- Avg merge
- 42m
- Merged PRs (30d)
- 2
Description
The encoder= parameter in our API leads to some confusing bugs like #525; if we remove all its usages, we'll be able to remove the nacl.encodings module which just duplicates functionality already present in the standard library.
The involved modules are:
- signing
- public
- secret
- hash
- pwhash
- encoding
Contributor guide
No contributing guide indexed for this repository
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 by locating the signing, public, secret, hash, pwhash, and encoding modules and searching their APIs for encoder= usage. Review the existing tests and call sites for each module, then confirm that all encoder parameters and uses are removed and that the nacl.encodings module can be deleted without breaking the test suite.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cryptography
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100