GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — doc: fix display of "problematic" ASCII characters by Alhadis · Pull Request #44373 · nodejs/node

Conversation

@Alhadis

@Alhadis Alhadis commented Aug 24, 2022

Copy link
Copy Markdown
Contributor

When preparing output for a terminal that supports Unicode, Groff remaps the following characters to typographically "fancier" versions:

^ (U+005E)  ->  ˆ (U+02C6)
~ (U+007E)  ->  ˜ (U+02DC)
- (U+002D)  ->  ‐ (U+2010)
` (U+0060)  ->  ‘ (U+2018)
' (U+0027)  ->  ’ (U+2019)

This transformation is normally desirable in high-quality typeset output (i.e., PDF and PostScript), but frequently problematic in terminal display. As described in groff_char(7), the following escape sequences are needed to display the aforementioned characters as they appear in source code:

^   ->   \(ha   (Mnemonic: "hat")
~   ->   \(ti   (Mnemonic: "tilde")
-   ->   \-
`   ->   \(ga   (Mnemonic: "grave accent")
'   ->   \(aq   (Mnemonic: "apostrophe quote")

These constructs are cumbersome to write, obstruct readability of source code, and are completely opaque to the majority of man page authors (who only care about terminal display). A simpler solution is to use Roff's .tr to translate these characters automatically.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
bricss reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@Alhadis
doc: fix display of "problematic" ASCII characters
72adfd6 
When preparing output for a terminal that supports Unicode, Groff remaps
the following characters to typographically "fancier" versions:

    ^ (U+005E)  ->  ˆ (U+02C6)
    ~ (U+007E)  ->  ˜ (U+02DC)
    - (U+002D)  ->  ‐ (U+2010)
    ` (U+0060)  ->  ‘ (U+2018)
    ' (U+0027)  ->  ’ (U+2019)

This transformation is normally desirable in high-quality typeset output
(PDF and PostScript), but frequently problematic in terminal display. As
described in groff_char(7), the following escape sequences are needed to
display the aforementioned characters as they appear in source code:

    ^   ->   \(ha   (Mnemonic: "hat")
    ~   ->   \(ti   (Mnemonic: "tilde")
    -   ->   \-
    `   ->   \(ga   (Mnemonic: "grave accent")
    '   ->   \(aq   (Mnemonic: "apostrophe quote")

These constructs are cumbersome to write, obstruct readability of source
code, and are completely opaque to the majority of man page authors (who
only care about terminal display). A simpler solution is to use `.tr` to
translate these characters automatically.
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to Node.js documentation. label Aug 24, 2022
jasnell
jasnell approved these changes Aug 28, 2022
View reviewed changes
@Alhadis

Alhadis commented Oct 21, 2022

Copy link
Copy Markdown
Contributor Author

@jasnell Is this blocked on anything?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@jasnell jasnell added the commit-queue PRs queued for automated landing through the Commit Queue. label Oct 21, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Oct 21, 2022
@nodejs-github-bot
nodejs-github-bot merged commit 9dddc6a into nodejs:main Oct 21, 2022
@nodejs-github-bot

nodejs-github-bot commented Oct 21, 2022

Copy link
Copy Markdown
Collaborator

Landed in 9dddc6a
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Alhadis
Alhadis deleted the man-punct branch October 21, 2022 15:12
@jasnell

jasnell commented Oct 21, 2022

Copy link
Copy Markdown
Member

Looks like it just fell through the cracks. Landed now!
Alhadis reacted with heart emoji
All reactions
  • ❤️ 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@Alhadis

Alhadis commented Oct 21, 2022

Copy link
Copy Markdown
Contributor Author

Awesome, thank you! 🎉
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
RafaelGSS pushed a commit that referenced this pull request Nov 1, 2022
@Alhadis @RafaelGSS
doc: fix display of "problematic" ASCII characters
41f6ec1 
When preparing output for a terminal that supports Unicode, Groff remaps
the following characters to typographically "fancier" versions:

    ^ (U+005E)  ->  ˆ (U+02C6)
    ~ (U+007E)  ->  ˜ (U+02DC)
    - (U+002D)  ->  ‐ (U+2010)
    ` (U+0060)  ->  ‘ (U+2018)
    ' (U+0027)  ->  ’ (U+2019)

This transformation is normally desirable in high-quality typeset output
(PDF and PostScript), but frequently problematic in terminal display. As
described in groff_char(7), the following escape sequences are needed to
display the aforementioned characters as they appear in source code:

    ^   ->   \(ha   (Mnemonic: "hat")
    ~   ->   \(ti   (Mnemonic: "tilde")
    -   ->   \-
    `   ->   \(ga   (Mnemonic: "grave accent")
    '   ->   \(aq   (Mnemonic: "apostrophe quote")

These constructs are cumbersome to write, obstruct readability of source
code, and are completely opaque to the majority of man page authors (who
only care about terminal display). A simpler solution is to use `.tr` to
translate these characters automatically.

PR-URL: #44373
Reviewed-By: James M Snell <[email protected]>
@RafaelGSS RafaelGSS mentioned this pull request Nov 1, 2022
v19.1.0 proposal #45269
Merged
RafaelGSS pushed a commit that referenced this pull request Nov 10, 2022
@Alhadis @RafaelGSS
doc: fix display of "problematic" ASCII characters
3e4033a 
When preparing output for a terminal that supports Unicode, Groff remaps
the following characters to typographically "fancier" versions:

    ^ (U+005E)  ->  ˆ (U+02C6)
    ~ (U+007E)  ->  ˜ (U+02DC)
    - (U+002D)  ->  ‐ (U+2010)
    ` (U+0060)  ->  ‘ (U+2018)
    ' (U+0027)  ->  ’ (U+2019)

This transformation is normally desirable in high-quality typeset output
(PDF and PostScript), but frequently problematic in terminal display. As
described in groff_char(7), the following escape sequences are needed to
display the aforementioned characters as they appear in source code:

    ^   ->   \(ha   (Mnemonic: "hat")
    ~   ->   \(ti   (Mnemonic: "tilde")
    -   ->   \-
    `   ->   \(ga   (Mnemonic: "grave accent")
    '   ->   \(aq   (Mnemonic: "apostrophe quote")

These constructs are cumbersome to write, obstruct readability of source
code, and are completely opaque to the majority of man page authors (who
only care about terminal display). A simpler solution is to use `.tr` to
translate these characters automatically.

PR-URL: #44373
Reviewed-By: James M Snell <[email protected]>
@danielleadams danielleadams mentioned this pull request Dec 30, 2022
v18.13.0 release proposal #46025
Merged
danielleadams pushed a commit that referenced this pull request Dec 30, 2022
@Alhadis @danielleadams
doc: fix display of "problematic" ASCII characters
28227cc 
When preparing output for a terminal that supports Unicode, Groff remaps
the following characters to typographically "fancier" versions:

    ^ (U+005E)  ->  ˆ (U+02C6)
    ~ (U+007E)  ->  ˜ (U+02DC)
    - (U+002D)  ->  ‐ (U+2010)
    ` (U+0060)  ->  ‘ (U+2018)
    ' (U+0027)  ->  ’ (U+2019)

This transformation is normally desirable in high-quality typeset output
(PDF and PostScript), but frequently problematic in terminal display. As
described in groff_char(7), the following escape sequences are needed to
display the aforementioned characters as they appear in source code:

    ^   ->   \(ha   (Mnemonic: "hat")
    ~   ->   \(ti   (Mnemonic: "tilde")
    -   ->   \-
    `   ->   \(ga   (Mnemonic: "grave accent")
    '   ->   \(aq   (Mnemonic: "apostrophe quote")

These constructs are cumbersome to write, obstruct readability of source
code, and are completely opaque to the majority of man page authors (who
only care about terminal display). A simpler solution is to use `.tr` to
translate these characters automatically.

PR-URL: #44373
Reviewed-By: James M Snell <[email protected]>
danielleadams pushed a commit that referenced this pull request Jan 3, 2023
@Alhadis @danielleadams
doc: fix display of "problematic" ASCII characters
b4e3f3f 
When preparing output for a terminal that supports Unicode, Groff remaps
the following characters to typographically "fancier" versions:

    ^ (U+005E)  ->  ˆ (U+02C6)
    ~ (U+007E)  ->  ˜ (U+02DC)
    - (U+002D)  ->  ‐ (U+2010)
    ` (U+0060)  ->  ‘ (U+2018)
    ' (U+0027)  ->  ’ (U+2019)

This transformation is normally desirable in high-quality typeset output
(PDF and PostScript), but frequently problematic in terminal display. As
described in groff_char(7), the following escape sequences are needed to
display the aforementioned characters as they appear in source code:

    ^   ->   \(ha   (Mnemonic: "hat")
    ~   ->   \(ti   (Mnemonic: "tilde")
    -   ->   \-
    `   ->   \(ga   (Mnemonic: "grave accent")
    '   ->   \(aq   (Mnemonic: "apostrophe quote")

These constructs are cumbersome to write, obstruct readability of source
code, and are completely opaque to the majority of man page authors (who
only care about terminal display). A simpler solution is to use `.tr` to
translate these characters automatically.

PR-URL: #44373
Reviewed-By: James M Snell <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnell jasnell jasnell approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

doc Issues and PRs related to Node.js documentation.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@Alhadis @nodejs-github-bot @jasnell
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.