Skip to content

Commit 231a552

Browse files
committed
doc: Tidying of "Planned Changes"
1 parent b32e277 commit 231a552

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

ffuzzy/src/_docs/planned_changes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Planned Changes
1+
# Planned Breaking Changes
22

33
This page lists (incomplete) list of planned changes
44
on the next major release (most likely version 0.4).
@@ -7,7 +7,7 @@ on the next major release (most likely version 0.4).
77
## Major design change (and `prelude` module)
88

99
The next major release will heavily utilize traits and for convenience, you
10-
will want to import `ssdeep::prelude::*`.
10+
will want to import [`ssdeep::prelude::*`](crate::prelude).
1111

1212
This module is added in version 0.3.13.
1313

@@ -22,7 +22,7 @@ to that edition.
2222
* Edition 2024 case: 1.85 (not released yet)
2323

2424

25-
## Deprecation of `+=` operator overload
25+
## Removal of `+=` operator overload
2626

2727
Since it's clear that this operator overload is not helpful enough,
2828
they are now deprecated and will be removed on the next major release.

ffuzzy/src/_docs/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ source code for details).
237237

238238
## Internal References (For Developers)
239239

240-
* [Planned Changes](crate::_docs::planned_changes)
240+
* [Planned Breaking Changes (most likely in version 0.4)](crate::_docs::planned_changes)
241241
* [Compatibility Policy](crate::_docs::compat_policy)
242242
* [Compatibility Note about SemVer Violation](crate::_docs::compat_semver_violation)
243243
* [Implementation Notes](crate::_docs::internals::impl_notes)

0 commit comments

Comments
 (0)