Skip to content
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

NB -> Note #528

Closed
Topsii opened this issue Aug 27, 2022 · 2 comments
Closed

NB -> Note #528

Topsii opened this issue Aug 27, 2022 · 2 comments

Comments

@Topsii
Copy link

Topsii commented Aug 27, 2022

I just looked up that NB: means nota bene.
https://en.wikipedia.org/wiki/Nota_bene

In Modern English, it is used, particularly in legal papers, to draw the attention of the reader to a certain (side) aspect or detail of the subject being addressed. While NB is also often used in academic writing, note is a common substitute.

I suggest to replace NB: with Note: in GHC's error messages.

I saw NB in this recently added error message:

• The ‘~’ operator is out of scope.
  Assuming it to stand for an equality constraint.
• NB: ‘~’ used to be built-in syntax but now is a regular type operator
      exported from Data.Type.Equality and Prelude.
  If you are using a custom Prelude, consider re-exporting it.

Though I must have skipped it when reading errors for years. After all NB is pervasively used in GHC's error messages.

For me it is definitely no major issue, but it has always been another part that confuses more than it explains.

@cbrt-x
Copy link

cbrt-x commented May 20, 2024

I'll work on an implementation

@cbrt-x
Copy link

cbrt-x commented May 29, 2024

https://gitlab.haskell.org/ghc/ghc/-/merge_requests/12751

@Topsii Topsii closed this as completed Jun 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants