aws / aws/aws-encryption-sdk-python
encrypt/decrypt/stream API docs are missing new commitment_policy parameter
Open
- Dominant language
- Python
- Stars
- 255
- Forks
- 92
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 2
Description
I was talking with @seebees about this and noticed that the changes to the encrypt/decrypt/stream API parameters was not documented in the docstrings (and thus the rendered API docs).
Contributor guide
Research direction
Locate the encrypt, decrypt, and stream API docstrings and compare their documented parameters with the current commitment_policy argument. Update the missing parameter documentation and verify that the rendered API docs include it for all three APIs.
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