-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
5 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,10 @@ | ||
<!-- SPDX-FileCopyrightText: 2023 geisserml <geisserml@gmail.com> --> | ||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
|
||
# Planned Changes | ||
|
||
<!-- Currently, no API breaking changes are planned. --> | ||
<!-- TODO remove planned_changes.md and merge content into some other file --> | ||
|
||
```{note} | ||
You may search for `TODO(apibreak)` to find the code spots in question. | ||
``` | ||
|
||
The following API breaking changes are in consideration for a future release: | ||
# Planned Changes | ||
|
||
- The `PdfDocument.get_toc()` / `PdfOutlineItem` API will be changed. | ||
* The parameters `is_closed` (bool) and `n_kids` (abs int) will be replaced by `count` (int), | ||
where the state corresponds to the value's sign. | ||
* Instead of loading bookmark info into namedtuples in a predefined fashion, a wrapper | ||
around the raw pdfium object with on-demand properties shall be returned. | ||
To find out about possible planned changes, you can ... | ||
* Search the codebase for `TODO(apibreak)`. | ||
* Check if there is a development branch. If so, take a look at its changelog (`docs/devel/changelog_staging.md`). |