aws-cloudformation / aws-cloudformation/cloudformation-cli
Set Type Default Version incorrect parameter description.
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 337
- Forks
- 172
- Ø Merge
- 3 T. 5 Min.
- Gemergte PRs (30 T.)
- 3
Beschreibung
The description for the `Arn` parameter on [set-type-default-version](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cloudformation.html#CloudFormation.Client.set_type_default_version) appears to be a copy of another method's parameter.
Updating this to reflect that it accepts the `TypeVersionArn` from a `register-type` call would help users understand if/when they need to supply the `version` property as well.
```text
The Amazon Resource Name (ARN) of the type for which you want version summary information.
```
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der verknüpften CloudFormation API-Dokumentation für set-type-default-version und vergleiche die Beschreibung des Arn-Parameters mit der register-type-Antwort. Aktualisiere die Beschreibung, um zu erklären, dass sie TypeVersionArn akzeptiert, einschließlich der Fälle, in denen die version-Eigenschaft benötigt wird. Als erledigt gilt, wenn die generierte oder veröffentlichte Dokumentation den Parameter korrekt beschreibt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- aws
- Bereich
- cloud, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 45/100