Skip to content

Commit ea1e48a

Browse files
committed
feat: update help text and output msg
Signed-off-by: Snehil Shah <[email protected]>
1 parent 1647cb7 commit ea1e48a

File tree

2 files changed

+82
-79
lines changed

2 files changed

+82
-79
lines changed

lib/node_modules/@stdlib/repl/lib/help_text.js

Lines changed: 81 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -22,84 +22,87 @@
2222

2323
var MSG = [
2424
'',
25-
' help() Print help text.',
26-
' help(alias) Print help text for a specified alias.',
27-
' help(alias.<key>) Print help text for a specified property.',
28-
'',
29-
' info(alias) Print brief help text for a specified alias.',
30-
' info(alias.<key>) Print brief help text for a specified property.',
31-
'',
32-
' example(alias) Run examples for a specified alias.',
33-
' example(alias.<key>) Run examples for a specified property.',
34-
'',
35-
' tutorial() List tutorials.',
36-
' tutorial(name) Run a specified tutorial.',
37-
'',
38-
' settings() List settings.',
39-
' settings(name) Return setting value.',
40-
' settings(name,value) Set a specified setting value.',
41-
'',
42-
' ans Return the result of the last executed command.',
43-
' vars() List current workspace variable names.',
44-
' clearVars() Delete current workspace variables.',
45-
'',
46-
' workspace() Switch to a specified (possibly new) workspace.',
47-
' workspaces() List workspace names.',
48-
' isWorkspace() Assert whether a workspace exists.',
49-
' varsWorkspace() List workspace variable names.',
50-
' loadWorkspace() Load variables from a specified workspace.',
51-
' clearWorkspace() Delete variables in a specified workspace.',
52-
' deleteWorkspace() Delete a specified workspace.',
53-
' renameWorkspace() Rename a specified workspace.',
54-
' currentWorkspace Return the name of the current workspace.',
55-
'',
56-
' themes() List available color themes.',
57-
' addTheme(name,value) Add a new color theme.',
58-
' deleteTheme(name) Delete a specified color theme.',
59-
' renameTheme(old,new) Rename a specified color theme.',
60-
' getTheme([name]) Return the current (or a specified) theme\'s color palette.',
61-
'',
62-
' assignin() Assign a value to a workspace variable.',
63-
' assignfrom() Read in a value from another workspace.',
64-
'',
65-
' evalin() Evaluate an expression in a specified workspace.',
66-
'',
67-
' rerun() Rerun previous commands.',
68-
'',
69-
' require() Import a module, JSON, or local file.',
70-
' rerequire() Re-import a module, JSON, or local file.',
71-
' deeprerequire() Re-import a module and its dependencies.',
72-
' load() Load and evaluate a JavaScript file line-by-line.',
73-
'',
74-
' save() Save previous commands to a specified file.',
75-
' saveStart() Start saving commands to a specified file.',
76-
' saveStop() Stop saving commands.',
77-
'',
78-
' presentationStart() Start a REPL presentation.',
79-
' presentationStop() Stop a REPL presentation.',
80-
'',
81-
' userDoc() Add user-defined documentation.',
82-
' clearUserDocs() Clear user-defined documentation.',
83-
'',
84-
' clearHistory() Clear the REPL history.',
85-
'',
86-
' clear() Clear the entire REPL screen and scrollback history.',
87-
' reset() Reset the REPL.',
88-
' quit() Exit the REPL.',
89-
'',
90-
' aliases() List namespace contents.',
91-
' alias2pkg() Convert an alias to a stdlib package name.',
92-
' pkg2alias() Convert a stdlib package name to an alias.',
93-
' alias2related() List related aliases.',
94-
' pkg2related() List related package names.',
95-
' isKeyword() Assert whether a value is a reserved keyword/alias.',
96-
'',
97-
' citation() Print how to cite stdlib in publications.',
98-
' license() Print license information.',
99-
' copyright() Print copyright information.',
100-
' contributors() List contributors.',
101-
' credits() Print credits.',
102-
' donate() Print donation information.',
25+
' help() Print help text.',
26+
' help(alias) Print help text for a specified alias.',
27+
' help(alias.<key>) Print help text for a specified property.',
28+
'',
29+
' info(alias) Print brief help text for a specified alias.',
30+
' info(alias.<key>) Print brief help text for a specified property.',
31+
'',
32+
' example(alias) Run examples for a specified alias.',
33+
' example(alias.<key>) Run examples for a specified property.',
34+
'',
35+
' tutorial() List tutorials.',
36+
' tutorial(name) Run a specified tutorial.',
37+
'',
38+
' settings() List settings.',
39+
' settings(name) Return setting value.',
40+
' settings(name,value) Set a specified setting value.',
41+
'',
42+
' ans Return the result of the last executed command.',
43+
' vars() List current workspace variable names.',
44+
' clearVars() Delete current workspace variables.',
45+
'',
46+
' workspace() Switch to a specified (possibly new) workspace.',
47+
' workspaces() List workspace names.',
48+
' isWorkspace() Assert whether a workspace exists.',
49+
' varsWorkspace() List workspace variable names.',
50+
' loadWorkspace() Load variables from a specified workspace.',
51+
' clearWorkspace() Delete variables in a specified workspace.',
52+
' deleteWorkspace() Delete a specified workspace.',
53+
' renameWorkspace() Rename a specified workspace.',
54+
' currentWorkspace Return the name of the current workspace.',
55+
'',
56+
' themes() List available color themes.',
57+
' addTheme(name,value) Add a new color theme.',
58+
' deleteTheme(name) Delete a specified color theme.',
59+
' renameTheme(old,new) Rename a specified color theme.',
60+
' getTheme([name]) Return the current (or a specified) theme\'s color palette.',
61+
'',
62+
' keybindings([name]) List all (or select) keybindings.',
63+
' setKeybinding(name,[keys]) Set a keybinding.',
64+
'',
65+
' assignin() Assign a value to a workspace variable.',
66+
' assignfrom() Read in a value from another workspace.',
67+
'',
68+
' evalin() Evaluate an expression in a specified workspace.',
69+
'',
70+
' rerun() Rerun previous commands.',
71+
'',
72+
' require() Import a module, JSON, or local file.',
73+
' rerequire() Re-import a module, JSON, or local file.',
74+
' deeprerequire() Re-import a module and its dependencies.',
75+
' load() Load and evaluate a JavaScript file line-by-line.',
76+
'',
77+
' save() Save previous commands to a specified file.',
78+
' saveStart() Start saving commands to a specified file.',
79+
' saveStop() Stop saving commands.',
80+
'',
81+
' presentationStart() Start a REPL presentation.',
82+
' presentationStop() Stop a REPL presentation.',
83+
'',
84+
' userDoc() Add user-defined documentation.',
85+
' clearUserDocs() Clear user-defined documentation.',
86+
'',
87+
' clearHistory() Clear the REPL history.',
88+
'',
89+
' clear() Clear the entire REPL screen and scrollback history.',
90+
' reset() Reset the REPL.',
91+
' quit() Exit the REPL.',
92+
'',
93+
' aliases() List namespace contents.',
94+
' alias2pkg() Convert an alias to a stdlib package name.',
95+
' pkg2alias() Convert a stdlib package name to an alias.',
96+
' alias2related() List related aliases.',
97+
' pkg2related() List related package names.',
98+
' isKeyword() Assert whether a value is a reserved keyword/alias.',
99+
'',
100+
' citation() Print how to cite stdlib in publications.',
101+
' license() Print license information.',
102+
' copyright() Print copyright information.',
103+
' contributors() List contributors.',
104+
' credits() Print credits.',
105+
' donate() Print donation information.',
103106
'',
104107
''
105108
].join( '\n' );

lib/node_modules/@stdlib/repl/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@ setNonEnumerableReadOnly( REPL.prototype, '_captureKeybinding', function capture
576576
}
577577
parsedKeys = parseKey( key );
578578
this.setKeybinding( this._targetAction, parsedKeys );
579-
this._ostream.write( format( '\n\nSuccessfully set the following keybindings for action: `%s`.\n\n%s\n', this._targetAction, JSON.stringify( parsedKeys, null, 2 ) ) );
579+
this._ostream.write( format( '\n\nSuccessfully set the following keybindings for action `%s`.\n\n%s\n', this._targetAction, JSON.stringify( parsedKeys, null, 2 ) ) );
580580
this._isCapturingKeybinding = false;
581581
this._targetAction = '';
582582
displayPrompt( this, false );

0 commit comments

Comments
 (0)