Skip to content

Commit 36ec47c

Browse files
committed
all: replace "NB:" with "Note:" (docs/comments)
1 parent f74b65b commit 36ec47c

File tree

131 files changed

+209
-209
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

131 files changed

+209
-209
lines changed

cmd/tools/detect_tcc.v

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ fn main() {
55
}
66

77
println('
8-
NB: `tcc` was not used, so unless you install it yourself, your backend
8+
Note: `tcc` was not used, so unless you install it yourself, your backend
99
C compiler will be `cc`, which is usually either `clang`, `gcc` or `msvc`.
1010
1111
These C compilers, are several times slower at compiling C source code,

cmd/tools/modules/testing/common.v

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -452,7 +452,7 @@ pub fn prepare_test_session(zargs string, folder string, oskipped []string, main
452452
mut skipped := oskipped.clone()
453453
next_file: for f in files {
454454
fnormalised := f.replace('\\', '/')
455-
// NB: a `testdata` folder, is the preferred name of a folder, containing V code,
455+
// Note: a `testdata` folder, is the preferred name of a folder, containing V code,
456456
// that you *do not want* the test framework to find incidentally for various reasons,
457457
// for example module import tests, or subtests, that are compiled/run by other parent tests
458458
// in specific configurations, etc.

cmd/tools/modules/vgit/vgit.v

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ pub fn prepare_vc_source(vcdir string, cdir string, commit string) (string, stri
7575
}
7676

7777
pub fn clone_or_pull(remote_git_url string, local_worktree_path string) {
78-
// NB: after clone_or_pull, the current repo branch is === HEAD === master
78+
// Note: after clone_or_pull, the current repo branch is === HEAD === master
7979
if os.is_dir(local_worktree_path) && os.is_dir(os.join_path_single(local_worktree_path, '.git')) {
8080
// Already existing ... Just pulling in this case is faster usually.
8181
scripting.run('git -C "$local_worktree_path" checkout --quiet master')

cmd/tools/oldv.v

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ fn (mut c Context) compile_oldv_if_needed() {
5757
c.vgcontext.compile_oldv_if_needed()
5858
c.commit_v_hash = c.vgcontext.commit_v__hash
5959
if !os.exists(c.vgcontext.vexepath) && c.cmd_to_run.len > 0 {
60-
// NB: 125 is a special code, that git bisect understands as 'skip this commit'.
60+
// Note: 125 is a special code, that git bisect understands as 'skip this commit'.
6161
// it is used to inform git bisect that the current commit leads to a build failure.
6262
exit(125)
6363
}

cmd/tools/repeat.v

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ fn (mut context Context) parse_options() ? {
152152
mut fp := flag.new_flag_parser(os.args)
153153
fp.application(os.file_name(os.executable()))
154154
fp.version('0.0.1')
155-
fp.description('Repeat command(s) and collect statistics. NB: you have to quote each command, if it contains spaces.')
155+
fp.description('Repeat command(s) and collect statistics. Note: you have to quote each command, if it contains spaces.')
156156
fp.arguments_description('CMD1 CMD2 ...')
157157
fp.skip_executable()
158158
fp.limit_free_args_to_at_least(1) ?
@@ -161,7 +161,7 @@ fn (mut context Context) parse_options() ? {
161161
context.warmup = fp.int('warmup', `w`, 2, 'Warmup runs. These are done *only at the start*, and are ignored.')
162162
context.show_help = fp.bool('help', `h`, false, 'Show this help screen.')
163163
context.use_newline = fp.bool('newline', `n`, false, 'Use \\n, do not overwrite the last line. Produces more output, but easier to diagnose.')
164-
context.show_output = fp.bool('output', `O`, false, 'Show command stdout/stderr in the progress indicator for each command. NB: slower, for verbose commands.')
164+
context.show_output = fp.bool('output', `O`, false, 'Show command stdout/stderr in the progress indicator for each command. Note: slower, for verbose commands.')
165165
context.verbose = fp.bool('verbose', `v`, false, 'Be more verbose.')
166166
context.fail_on_maxtime = fp.int('max_time', `m`, max_time, 'Fail with exit code 2, when first cmd takes above M milliseconds (regression).')
167167
context.fail_on_regress_percent = fp.int('fail_percent', `f`, max_fail_percent, 'Fail with exit code 3, when first cmd is X% slower than the rest (regression).')

cmd/tools/vbuild-tools.v

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import os
44
import testing
55
import v.util
66

7-
// NB: tools like vdoc are compiled in their own subfolder
7+
// Note: tools like vdoc are compiled in their own subfolder
88
// => cmd/tools/vdoc/vdoc.exe
99
// Usually, they have several top level .v files in the subfolder,
1010
// that cannot be compiled separately, but instead, the whole folder,

cmd/tools/vfmt.v

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ import vhelp
1717

1818
struct FormatOptions {
1919
is_l bool
20-
is_c bool // NB: This refers to the '-c' fmt flag, NOT the C backend
20+
is_c bool // Note: This refers to the '-c' fmt flag, NOT the C backend
2121
is_w bool
2222
is_diff bool
2323
is_verbose bool
2424
is_all bool
2525
is_debug bool
2626
is_noerror bool
2727
is_verify bool // exit(1) if the file is not vfmt'ed
28-
is_worker bool // true *only* in the worker processes. NB: workers can crash.
28+
is_worker bool // true *only* in the worker processes. Note: workers can crash.
2929
is_backup bool // make a `file.v.bak` copy *before* overwriting a `file.v` in place with `-w`
3030
}
3131

cmd/tools/vrepl.v

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ fn print_welcome_screen() {
225225
]
226226
help_text := [
227227
'Welcome to the V REPL (for help with V itself, type $cmd_exit, then run $cmd_help).',
228-
'NB: the REPL is highly experimental. For best V experience, use a text editor, ',
228+
'Note: the REPL is highly experimental. For best V experience, use a text editor, ',
229229
'save your code in a $file_main file and execute: $cmd_run',
230230
version.full_v_version(false),
231231
'Use Ctrl-C or ${term.highlight_command('exit')} to exit, or ${term.highlight_command('help')} to see other available commands',
@@ -387,7 +387,7 @@ fn run_repl(workdir string, vrepl_prefix string) {
387387
}
388388
}
389389
}
390-
// NB: starting a line with 2 spaces escapes the println heuristic
390+
// Note: starting a line with 2 spaces escapes the println heuristic
391391
if oline.starts_with(' ') {
392392
is_statement = true
393393
}

cmd/tools/vtest-all.v

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ fn get_all_commands() []Command {
173173
}
174174
res << Command{
175175
line: '$vexe $vargs -progress test-fmt'
176-
okmsg: 'All .v files can be processed with `v fmt`. NB: the result may not always be compilable, but `v fmt` should not crash.'
176+
okmsg: 'All .v files can be processed with `v fmt`. Note: the result may not always be compilable, but `v fmt` should not crash.'
177177
}
178178
res << Command{
179179
line: '$vexe $vargs -progress test-self'
@@ -201,7 +201,7 @@ fn get_all_commands() []Command {
201201
okmsg: '`v -usecache -cg` works.'
202202
rmfile: 'examples/hello_world'
203203
}
204-
// NB: test that a program that depends on thirdparty libraries with its
204+
// Note: test that a program that depends on thirdparty libraries with its
205205
// own #flags (tetris depends on gg, which uses sokol) can be compiled
206206
// with -usecache:
207207
res << Command{

cmd/tools/vtest-parser.v

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ fn process_cli_args() &Context {
103103
fp.description('Test the V parser, by parsing each .v file in each PATH,\n' +
104104
'as if it was typed character by character by the user.\n' +
105105
'A PATH can be either a folder, or a specific .v file.\n' +
106-
'NB: you *have to quote* the PATH, if it contains spaces/punctuation.')
106+
'Note: you *have to quote* the PATH, if it contains spaces/punctuation.')
107107
fp.arguments_description('PATH1 PATH2 ...')
108108
fp.skip_executable()
109109
context.is_help = fp.bool('help', `h`, false, 'Show help/usage screen.')

0 commit comments

Comments
 (0)