Skip to content

Commit

Permalink
Clean up planned changes
Browse files Browse the repository at this point in the history
  • Loading branch information
mara004 committed Sep 3, 2023
1 parent f145e5e commit 7e77b26
Showing 1 changed file with 5 additions and 13 deletions.
18 changes: 5 additions & 13 deletions docs/source/planned_changes.md
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`).

0 comments on commit 7e77b26

Please sign in to comment.