Skip to content
This repository has been archived by the owner on Jan 14, 2025. It is now read-only.

Fix typo and add example to message() and highlight() #24

Merged
merged 2 commits into from
Dec 13, 2018
Merged

Conversation

srawlins
Copy link
Member

@srawlins srawlins commented Dec 13, 2018

Typo is s/ANSII/ANSI/ and I found the doc insufficient in describing what format the ANSI code should be supplied in.

@srawlins srawlins requested a review from nex3 December 13, 2018 16:56
/// highlight the span's text. If it's `true`, it indicates that the text
/// should be highlighted using the default color. If it's `false` or `null`,
/// it indicates that the text shouldn't be highlighted.
/// it indicates an ANSI terminal color escape that should be used to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's probably a good idea to link "ANSI terminal color escape" to https://en.wikipedia.org/wiki/ANSI_escape_code#Colors.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

/// should be highlighted using the default color. If it's `false` or `null`,
/// it indicates that the text shouldn't be highlighted.
/// it indicates an ANSI terminal color escape that should be used to
/// highlight the span's text (e.g. `"\u001b[31m"` will color red). If it's
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: avoid "e.g.".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Add a link, s/e.g./for example,/
@nex3 nex3 merged commit 8dcacc4 into master Dec 13, 2018
@nex3 nex3 deleted the srawlins-patch-1 branch December 13, 2018 22:09
nex3 pushed a commit to nex3/source_span that referenced this pull request Jul 2, 2024
mosuem pushed a commit to dart-lang/tools that referenced this pull request Dec 10, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants