Skip to content

Commit

Permalink
Docs-improve: os.getCurrentCompilerExe replace with clearer short-desc
Browse files Browse the repository at this point in the history
The doc for `getCurrentCompilerExe`  was originally added at [this commit](c4e3c4c), saying "`getAppFilename` at CT", and modified as "This is `getAppFilename() <#getAppFilename>`_ at compile time..." since [this](0c2c2dc#diff-8ed10106605d9e0e3f28a927432acd8312e96791c96dbb126a52a7010cf4b44a)

Which means "at compile time, get result innerly from Nim compiler via `getAppFilename`", not "get from nim programs".

Thus, the doc was confusing, only mentioning `compile time` and `getAppFilename`
  • Loading branch information
litlighilit authored Jan 31, 2024
1 parent 98b083d commit 48ac458
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion lib/pure/os.nim
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ proc expandFilename*(filename: string): string {.rtl, extern: "nos$1",
c_free(cast[pointer](r))

proc getCurrentCompilerExe*(): string {.compileTime.} = discard
## This is `getAppFilename()`_ at compile time.
## Returns the current Nim compiler path or nimble executable path.
##
## Can be used to retrieve the currently executing
## Nim compiler from a Nim or nimscript program, or the nimble binary
Expand Down

0 comments on commit 48ac458

Please sign in to comment.