Skip to content

Conversation

@Hussseinkizz
Copy link

Fixed typos in /packages/printer/README.md

I think Document was intended not Doccument and so on across a few instances in the readme.

Type

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Description

Fixed typos in 3 instances in /packages/printer/README.md for clarity, mostly changed from Document to Document which seems to be the intended spelling.

Related

  • Related Issue #
  • Closes #

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.
Copilot AI review requested due to automatic review settings January 2, 2026 07:54
@Hussseinkizz Hussseinkizz requested a review from IMax153 as a code owner January 2, 2026 07:54
@github-project-automation github-project-automation bot moved this to Discussion Ongoing in PR Backlog Jan 2, 2026
@changeset-bot
Copy link

changeset-bot bot commented Jan 2, 2026

⚠️ No Changeset found

Latest commit: bc6384e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

Copilot AI left a 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.
Copy link

Copilot AI Jan 2, 2026

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.

Suggested change
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.

Copilot uses AI. Check for mistakes.
@IMax153
Copy link
Member

IMax153 commented Jan 2, 2026

@Hussseinkizz - Document was intended given that the module that the methods are imported from is called Doc.

@Hussseinkizz
Copy link
Author

@Hussseinkizz - Document was intended given that the module that the methods are imported from is called Doc.

Interesting, the docs are about code or instructions, or rather english instructions on how to use the module?
But anyways if you say such was intended then we can close this no problem.

@IMax153
Copy link
Member

IMax153 commented Jan 4, 2026

Thank you for the PR anyway! Much appreciated.

@IMax153 IMax153 closed this Jan 4, 2026
@github-project-automation github-project-automation bot moved this from Discussion Ongoing to Done in PR Backlog Jan 4, 2026
@Hussseinkizz
Copy link
Author

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants