Skip to content

Commit df8fbc5

Browse files
committed
Cleaning up docs on Terminal.
1 parent b5cd142 commit df8fbc5

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

libraries/node-core-library/src/Terminal/Terminal.ts

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ export class Terminal {
4949

5050
/**
5151
* Write a warning message to the console with yellow text.
52+
*
53+
* @remarks
54+
* The yellow color takes precedence over any other foreground colors set.
5255
*/
5356
public writeWarning(...messageParts: (string | IColorableSequence)[]): void {
5457
this._writeSegmentsToProviders(
@@ -61,6 +64,9 @@ export class Terminal {
6164

6265
/**
6366
* Write a warning message to the console with yellow text, followed by a newline.
67+
*
68+
* @remarks
69+
* The yellow color takes precedence over any other foreground colors set.
6470
*/
6571
public writeWarningLine(...messageParts: (string | IColorableSequence)[]): void {
6672
this._writeSegmentsToProviders(
@@ -76,6 +82,9 @@ export class Terminal {
7682

7783
/**
7884
* Write an error message to the console with red text.
85+
*
86+
* @remarks
87+
* The red color takes precedence over any other foreground colors set.
7988
*/
8089
public writeError(...messageParts: (string | IColorableSequence)[]): void {
8190
this._writeSegmentsToProviders(
@@ -88,6 +97,9 @@ export class Terminal {
8897

8998
/**
9099
* Write an error message to the console with red text, followed by a newline.
100+
*
101+
* @remarks
102+
* The red color takes precedence over any other foreground colors set.
91103
*/
92104
public writeErrorLine(...messageParts: (string | IColorableSequence)[]): void {
93105
this._writeSegmentsToProviders(
@@ -102,7 +114,7 @@ export class Terminal {
102114
}
103115

104116
/**
105-
* Write a verbose-level message. Messages are only written if verbose mode is turned on.
117+
* Write a verbose-level message.
106118
*/
107119
public writeVerbose(...messageParts: (string | IColorableSequence)[]): void {
108120
if (this.verboseEnabled) {
@@ -111,7 +123,7 @@ export class Terminal {
111123
}
112124

113125
/**
114-
* Write a verbose-level message followed by a newline. Messages are only written if verbose mode is turned on.
126+
* Write a verbose-level message followed by a newline.
115127
*/
116128
public writeVerboseLine(...messageParts: (string | IColorableSequence)[]): void {
117129
this.writeVerbose(...messageParts, { text: EOL });

0 commit comments

Comments
 (0)