Skip to content

Commit

Permalink
Multiple minor fixes in the version guarantees page
Browse files Browse the repository at this point in the history
  • Loading branch information
ItsDrike committed Aug 2, 2024
1 parent e9d6cc1 commit 5e79c26
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/version_guarantees.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ it can be hard to discern what can be considered a breaking change, and what isn

First thing to keep in mind is that breaking changes only apply to **publicly documented functions and classes**. If
it's not listed in the documentation here, it's an internal feature, that isn't considered a part of the public API,
and thus is bound to change. This includes documented attributes that start with an underscore.
and thus is bound to change. This includes documented attributes that start with an underscore and documented API
that is explicitly marked as internal.

!!! note

Expand All @@ -23,15 +24,15 @@ and thus is bound to change. This includes documented attributes that start with
- Changing the default parameter value of a function to something else.
- Renaming (or removing) a function without an alias to the old function.
- Adding or removing parameters of a function.
- Removing deprecated alias to a renamed function
- Removing deprecated alias to a renamed function.

## Examples of Non-Breaking Changes

- Changing function's name, while providing a deprecated alias.
- Renaming (or removing) private underscored attributes.
- Adding an element into `__slots__` of a data class.
- Changing the behavior of a function to fix a bug.
- Changes in the typing behavior of the library.
- Changes in the typing definitions of the public API.
- Changes in the documentation.
- Modifying the internal protocol connection handling.
- Updating the dependencies to a newer version, major or otherwise.

0 comments on commit 5e79c26

Please sign in to comment.