aws / aws/aws-encryption-sdk-python
encrypt/decrypt/stream API docs are missing new commitment_policy parameter
Offen
- Vorherrschende Sprache
- Python
- Sterne
- 255
- Forks
- 92
- Ø Merge
- 2 T. 17 Std.
- Gemergte PRs (30 T.)
- 2
Beschreibung
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).
Beitragsleitfaden
Rechercherichtung
Lokalisieren Sie die API-Docstrings von encrypt, decrypt und stream und vergleichen Sie deren dokumentierte Parameter mit dem aktuellen commitment_policy-Argument. Aktualisieren Sie die fehlende Parameterdokumentation und überprüfen Sie, dass die gerenderten API-Dokumente sie für alle drei APIs enthalten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100