Skip to content

Commit d04dfee

Browse files
authored
Update README.md
1 parent 736a977 commit d04dfee

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -370,17 +370,17 @@ client = Cloudflare(
370370

371371
By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
372372

373-
## Versioning
373+
## Semantic versioning
374374

375375
This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
376376

377377
1. Changes that only affect static types, without breaking runtime behavior.
378-
2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.
379-
3. Changes that we do not expect to impact the vast majority of users in practice.
378+
1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.
379+
1. Changes that we do not expect to impact the vast majority of users in practice.
380380

381-
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
382-
383-
We are keen for your feedback; please open an [issue](https://www.github.com/cloudflare/cloudflare-python/issues) with questions, bugs, or suggestions.
381+
> [!WARNING]
382+
> In addition to the above, changes to type names, structure or methods _may_ occur as we stabilise the automated codegen pipeline. This will be removed in the future once we are further along and the service owner OpenAPI schemas have reached a higher maturity level where changes are not as constant.
383+
> If this isn't suitable for your project, we recommend pinning to a known version or using the previous major version.
384384
385385
## Requirements
386386

0 commit comments

Comments
 (0)