mirrors/ghostty
1
0
Fork 0
mirror of https://github.com/ghostty-org/ghostty.git synced 2026-08-05 07:08:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

termio: fix doc comment grammar and PTY casing in message.zig (#13549)

Browse Source 
### What
Comment-only cleanup in `src/termio/message.zig`:

- Fixes a subject-verb agreement error in the `Message` union's doc
  comment: "the number of messages ... are also very few" -> "is also
  very small"
- Capitalizes "pty" to "PTY" in several doc comments 

### Why
Caught while reading through `message.zig`. No functional changes,
doc comments only.
This commit is contained in:
Mitchell Hashimoto
2026-08-02 07:03:19 -07:00
committed by GitHub
parent 322636bfb0 f5911d6964
commit f6830420ce
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/termio/message.zig
View File

@@ -8,21 +8,21 @@ const MessageData = @import("../datastruct/main.zig").MessageData;
/// The messages that can be sent to an IO thread.
///
/// This is not a tiny structure (~40 bytes at the time of writing this comment),
/// but the messages are IO thread sends are also very few. At the current size
/// we can queue 26,000 messages before consuming a MB of RAM.
/// but the number of messages we send to the IO thread is also very small.
/// At the current size we can queue 26,000 messages before consuming a MB of RAM.
pub const Message = union(enum) {
/// Represents a write request. Magic number comes from the largest
/// other union value. It can be upped if we add a larger union member
/// in the future.
pub const WriteReq = MessageData(u8, 38);
/// Request a color scheme report is sent to the pty.
/// Request a color scheme report is sent to the PTY.
color_scheme_report: struct {
/// Force write the current color scheme
force: bool,
},
/// Request a visibility report is sent to the pty.
/// Request a visibility report is sent to the PTY.
visibility_report: struct {
/// The visibility state to report.
visible: bool,
@@ -48,7 +48,7 @@ pub const Message = union(enum) {
/// Resize the window.
resize: renderer.Size,
/// Request a size report is sent to the pty ([in-band
/// Request a size report is sent to the PTY ([in-band
/// size report, mode 2048](https://gist.github.com/rockorager/e695fb2924d36b2bcf1fff4a3704bd83) and
/// [XTWINOPS](https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h4-Functions-using-CSI-_-ordered-by-the-final-character-lparen-s-rparen:CSI-Ps;Ps;Ps-t.1EB0)).
size_report: SizeReport,