jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarify paramStr / paramCount use and availability (#6727)

Browse source
This commit is contained in:
Federico Ceratto 2017-11-14 10:05:58 +00:00 • committed by Andreas Rumpf
commit ab938fc901
1 changed files with 11 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

20
lib/pure/os.nim
View file

@ -1195,14 +1195,15 @@ when defined(nimdoc):
## Returns the number of `command line arguments`:idx: given to the ## Returns the number of `command line arguments`:idx: given to the
## application. ## application.
## ##
## If your binary was called without parameters this will return zero. You ## Unlike `argc`:idx: in C, if your binary was called without parameters this
## can later query each individual paramater with `paramStr() <#paramStr>`_ ## will return zero.
## You can query each individual paramater with `paramStr() <#paramStr>`_
## or retrieve all of them in one go with `commandLineParams() ## or retrieve all of them in one go with `commandLineParams()
## <#commandLineParams>`_. ## <#commandLineParams>`_.
## ##
## **Availability**: On Posix there is no portable way to get the command ## **Availability**: When generating a dynamic library (see --app:lib) on
## line from a DLL and thus the proc isn't defined in this environment. You ## Posix this proc is not defined.
## can test for its availability with `declared() <system.html#declared>`_. ## Test for availability using `declared() <system.html#declared>`_.
## Example: ## Example:
## ##
## .. code-block:: nim ## .. code-block:: nim
@ -1219,13 +1220,14 @@ when defined(nimdoc):
## `paramCount() <#paramCount>`_ with this proc you can call the ## `paramCount() <#paramCount>`_ with this proc you can call the
## convenience `commandLineParams() <#commandLineParams>`_. ## convenience `commandLineParams() <#commandLineParams>`_.
## ##
## It is possible to call ``paramStr(0)`` but this will return OS specific ## Similarly to `argv`:idx: in C,
## it is possible to call ``paramStr(0)`` but this will return OS specific
## contents (usually the name of the invoked executable). You should avoid ## contents (usually the name of the invoked executable). You should avoid
## this and call `getAppFilename() <#getAppFilename>`_ instead. ## this and call `getAppFilename() <#getAppFilename>`_ instead.
## ##
## **Availability**: On Posix there is no portable way to get the command ## **Availability**: When generating a dynamic library (see --app:lib) on
## line from a DLL and thus the proc isn't defined in this environment. You ## Posix this proc is not defined.
## can test for its availability with `declared() <system.html#declared>`_. ## Test for availability using `declared() <system.html#declared>`_.
## Example: ## Example:
## ##
## .. code-block:: nim ## .. code-block:: nim