aws / aws/aws-encryption-sdk-python

encrypt/decrypt/stream API docs are missing new commitment_policy parameter

未关闭
#302 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
255
派生
92
平均合并
2 天 17 小时
30 天内合并 PR
2

描述

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).

贡献指南

打开贡献指南

调研方向

定位 encrypt、decrypt 和 stream 的 API 文档字符串,并将其中记录的参数与当前的 commitment_policy 参数进行比较。更新缺失的参数文档,并验证渲染后的 API 文档是否为这三个 API 都包含该参数。

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。