googleapis / googleapis/google-cloud-python

Create UPGRADING.md Migration Guide

Offen
#15,297 1 Kommentar 0 Reaktionen 1 zugewiesene Person Beansprucht von @gkevinzheng Auf GitHub ansehen
api: bigtable priority: p3 type: feature request
Vorherrschende Sprache
Python
Sterne
5.4k
Forks
1.8k
Ø Merge
3 T. 4 Std.
Gemergte PRs (30 T.)
122

Beschreibung

We expect the shim work to require a breaking change. We want the change to be as small as possible, but we may expect a different sequencing of exceptions, etc.

To track this, we need to maintain a migration guide in an UPGRADING.md file, detailing what users may need to change in their code. We should also link this into the docs. See [the one in python-logging](https://github.com/googleapis/python-logging/blob/main/UPGRADING.md) for an example

Ideally, we should start this immediately, and update it as changes are made

The content of this file should also be exposed in the public docs. But the first step is collecting the information, and then we can discuss the right places to expose it

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.