diff options
author | rockcavera <rockcavera@gmail.com> | 2024-01-23 18:48:18 -0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-01-23 22:48:18 +0100 |
commit | 9c155eacccbf437f907230621aee7e9f16f28930 (patch) | |
tree | 08f99e3fe44e5206e870bd002a723fc8759a52df /lib/system | |
parent | 06b9e603bcfe09266c858439c2c530a1c224888f (diff) | |
download | Nim-9c155eacccbf437f907230621aee7e9f16f28930.tar.gz |
Fix system.currentSourcePath() documentation [backport 2.0] (#23243)
The documentation links for `parentDir()` and `getCurrentDir()` are broken as they are no longer part of `std/os`. Link changed to `std/private/ospaths2`.
Diffstat (limited to 'lib/system')
-rw-r--r-- | lib/system/compilation.nim | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/lib/system/compilation.nim b/lib/system/compilation.nim index 7cf80eb17..cda16fae5 100644 --- a/lib/system/compilation.nim +++ b/lib/system/compilation.nim @@ -144,16 +144,17 @@ template currentSourcePath*: string = instantiationInfo(-1, true).filename ## Returns the full file-system path of the current source. ## ## To get the directory containing the current source, use it with - ## `os.parentDir() <os.html#parentDir%2Cstring>`_ as `currentSourcePath.parentDir()`. + ## `ospaths2.parentDir() <ospaths2.html#parentDir%2Cstring>`_ as + ## `currentSourcePath.parentDir()`. ## ## The path returned by this template is set at compile time. ## ## See the docstring of `macros.getProjectPath() <macros.html#getProjectPath>`_ - ## for an example to see the distinction between the `currentSourcePath` - ## and `getProjectPath`. + ## for an example to see the distinction between the `currentSourcePath()` + ## and `getProjectPath()`. ## ## See also: - ## * `getCurrentDir proc <os.html#getCurrentDir>`_ + ## * `ospaths2.getCurrentDir() proc <ospaths2.html#getCurrentDir>`_ proc slurp*(filename: string): string {.magic: "Slurp".} ## This is an alias for `staticRead <#staticRead,string>`_. |