swab.1: Clarify wording in Line 23 #177

Open
opened 2026-02-09 00:27:29 -07:00 by emma · 4 comments
Owner

docs/swab.1 Line 23 in d3c59ede0d
Configures the word size; that is, the size in bytes of the block size on which

https://git.tebibyte.media/bonsai/harakit/src/commit/d3c59ede0d236634045c965a4a623d0327d877bc/docs/swab.1#L23
Owner

What about this is unclear?

The wording could be better. I would write it now as

Configures the word size; that is, the size in bytes of the block on which...
What about this is unclear? The wording could be better. I would write it now as ``` Configures the word size; that is, the size in bytes of the block on which... ```
Author
Owner

“The size in bytes [...] block size” is redundant, “The block size, in bytes,
on which to operate” suffices.

“The size in bytes [...] block size” is redundant, “The block size, in bytes, on which to operate” suffices.
Owner

Do you have an opinion on my corrected wording?

Do you have an opinion on my corrected wording?
Author
Owner

I think I like it better than mine on second pass.

I think I like it better than mine on second pass.
emma added the
bug
enhancement
labels 2026-02-12 12:20:06 -07:00
Sign in to join this conversation.
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: bonsai/harakit#177
No description provided.