-
-
Notifications
You must be signed in to change notification settings - Fork 487
Fix typos in effect/printer README.md for clarity #5941
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Fixed typos in /packages/printer/README.md I think `Document` was intended not `Doc`cument and so on across a few instances in the readme.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR fixes typos in the printer package's README documentation, specifically correcting improperly backticked words where the backtick was splitting "Document" into `Doc`ument in two locations, and changing "layouter" to "layout" in one location.
Key changes:
- Fixed markdown formatting errors where backticks incorrectly split the word "Document" (lines 41 and 173)
- Changed "layouter" to "layout" in the overview section (line 41)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Overview | ||
|
|
||
| This module defines a pretty printer to format text in a flexible and convenient way. The idea is to combine a `Doc`ument out of many small components, then using a layouter to convert it to an easily renderable `DocStream`, which can then be rendered to a variety of formats. | ||
| This module defines a pretty printer to format text in a flexible and convenient way. The idea is to combine a `Document` out of many small components, then using a layout to convert it to an easily renderable `DocStream`, which can then be rendered to a variety of formats. |
Copilot
AI
Jan 2, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The change from "layouter" to "layout" creates awkward phrasing. The sentence now reads "using a layout to convert it" which is grammatically incomplete. Consider either:
- Keeping "layouter" (one who lays out)
- Changing to "layout algorithm" (to match terminology used elsewhere in the document, such as line 142-143 and line 173)
- Changing to "layout engine"
The rest of the document consistently refers to "layout algorithm" when describing this concept.
| This module defines a pretty printer to format text in a flexible and convenient way. The idea is to combine a `Document` out of many small components, then using a layout to convert it to an easily renderable `DocStream`, which can then be rendered to a variety of formats. | |
| This module defines a pretty printer to format text in a flexible and convenient way. The idea is to combine a `Document` out of many small components, and then apply a layout algorithm to convert it into an easily renderable `DocStream`, which can then be rendered to a variety of formats. |
|
@Hussseinkizz - |
Interesting, the docs are about code or instructions, or rather english instructions on how to use the module? |
|
Thank you for the PR anyway! Much appreciated. |
sure thank you too for taking your time to take a look, and well effect is awesome! |
Fixed typos in /packages/printer/README.md
I think
Documentwas intended notDoccument and so on across a few instances in the readme.Type
Description
Fixed typos in 3 instances in /packages/printer/README.md for clarity, mostly changed from
Document toDocumentwhich seems to be the intended spelling.Related