Skip to content

docs(textwrap): record future design directions - #14

Merged
joshka merged 1 commit into
mainfrom
joshka/textwrap-design-docs
Jul 17, 2026
Merged

docs(textwrap): record future design directions#14
joshka merged 1 commit into
mainfrom
joshka/textwrap-design-docs

Conversation

@joshka

@joshka joshka commented Jul 17, 2026

Copy link
Copy Markdown
Member

Summary

  • record the decisions behind the current wrapping and compatibility APIs
  • separate shipped contracts from possible future textwrap configuration and layout work
  • document incremental wrapping, source mapping, caching, indentation, and compatibility questions
  • include the design notes in the published package and link them from README and Rustdoc

Validation

  • just validate
  • RUSTDOCFLAGS='-D warnings' cargo doc -p ratatui-textwrap --no-deps
  • cargo test -p ratatui-textwrap
  • markdownlint-cli2 crates/ratatui-textwrap/README.md crates/ratatui-textwrap/docs/design.md
  • cargo package -p ratatui-textwrap --allow-dirty --list

@joshka
joshka merged commit 23a064a into main Jul 17, 2026
14 checks passed
@joshka
joshka deleted the joshka/textwrap-design-docs branch July 17, 2026 16:53
@github-actions github-actions Bot mentioned this pull request Jul 17, 2026
joshka pushed a commit that referenced this pull request Jul 17, 2026
## 🤖 New release

* `ratatui-textwrap`: 0.0.1-alpha.0 -> 0.0.1-alpha.1 (✓ API compatible
changes)
* `ratatui-labs`: 0.1.2 -> 0.1.3

<details><summary><i><b>Changelog</b></i></summary><p>

## `ratatui-textwrap`

<blockquote>

##
[0.0.1-alpha.1](ratatui-textwrap-v0.0.1-alpha.0...ratatui-textwrap-v0.0.1-alpha.1)
- 2026-07-17

### Other

- *(textwrap)* record future design directions
([#14](#14))
</blockquote>

## `ratatui-labs`

<blockquote>

##
[0.1.3](ratatui-labs-v0.1.2...ratatui-labs-v0.1.3)
- 2026-07-17

### Other

- updated the following local packages: ratatui-textwrap
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant