Skip to content

Commit bbf509d

Browse files
author
BuvinJ
committed
Docs clean up.
1 parent 48a5549 commit bbf509d

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

docs/LowLevel.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ program, invoke the buildExecutable function:
5454
you want specified relative to the package being
5555
created. Note that when using a **relative** source
5656
**outside** of the build directory, you MUST specify
57-
the corresponding the destination explictly if you
57+
the corresponding the destination explicitly if you
5858
wish for that to be **nested**, rather than placed
5959
on the package root.
6060

@@ -99,7 +99,7 @@ interface...).
9999

100100
### installQtIfw
101101

102-
When the QtIFW utlity is required for use by the library
102+
When the QtIFW utility is required for use by the library
103103
(i.e. when [buildInstaller](#buildinstaller) is invoked),
104104
an attempt will be made to resolve the path to it via a collection
105105
of methods. First, if a [QtIfwConfig](ConfigClasses.md#qtifwconfig) object is provided
@@ -142,7 +142,7 @@ an existing installation of the QtIFW utility.
142142
**Returns**: a boolean to indicate success or failure.
143143

144144
**qtIfwDirPath**: (Optional) The absolute path to the directory where the
145-
utlility was installed. (i.e. the return value of `installQtIfw()`). If omitted,
145+
utility was installed. (i.e. the return value of `installQtIfw()`). If omitted,
146146
the `version` argument will be looked to next.
147147

148148
**version**: (Optional) The version of QtIFW to uninstall. If `qtIfwDirPath` is
@@ -218,9 +218,9 @@ here, as they are already "included" implicitly.
218218
represented as a space delimited list of package ids. Only default components need to be listed
219219
here, those not automatically included they are already "excluded" implicitly.
220220

221-
**accept=[true/false]**: Enable the checkbox for accepting the end user license agreement.
221+
**accept=[true/false]**: Enable the check box for accepting the end user license agreement.
222222

223-
**run=[true/false]**: Enable the checkbox for running the target program at the end of
223+
**run=[true/false]**: Enable the check box for running the target program at the end of
224224
the installation.
225225

226226
**onexist=[fail/remove/prompt]**: Define the action taken when an existing (conflicting)
@@ -299,7 +299,7 @@ will all be be listed in the long manner.
299299

300300
### Installer Variables
301301

302-
The following constants have been provided, which correspond to dynamic varibles
302+
The following constants have been provided, which correspond to dynamic variables
303303
resolved at *runtime* by QtIFW. Note these are applicable for **BOTH** direct
304304
[Installer Script](#installer-scripting) generation, and as parameters
305305
and attributes for many higher level functions and objects in this library.
@@ -441,7 +441,7 @@ Static Functions:
441441

442442
clickButton( buttonName, delayMillis=None )
443443

444-
(Note: checkbox controls also work on radio buttons)
444+
(Note: check box controls also work on radio buttons)
445445
enableCheckBox( checkboxName )
446446
disableCheckBox( checkboxName )
447447
setCheckBox( checkboxName, boolean )
@@ -540,9 +540,9 @@ generated content, e.g. wrapper scripts, which were already added to the content
540540
Other customizations which need to be made must be applied post merge.
541541

542542
If a `subDirName` value is provided, that will be used to name the nested directory.
543-
If ommited, the child's package name will be used (or a truncated version of that
543+
If omitted, the child's package name will be used (or a truncated version of that
544544
if the child and parent share a common package name "prefix"). If the source package
545-
has a `subDirName` attribute, that detail will be overidden by this nesting. I.e.
545+
has a `subDirName` attribute, that detail will be overridden by this nesting. I.e.
546546
this will *NOT* nest the content two levels deep.
547547

548548
This function ultimately consolidates the package items in the list and returns
@@ -591,7 +591,7 @@ the horse's mouth:
591591

592592
One "solution" to this problem is to bundle `.pye` files instead of `.pyc`. PyInstaller
593593
provides built-in support for this, in fact. The alternate `.pye` is an *encrypted*
594-
equilavent to a `.pyc`. If your end user is in possession of the decryption key, they can run
594+
equivalent to a `.pyc`. If your end user is in possession of the decryption key, they can run
595595
the code, because it will be unlocked for them to begin the process of running it.
596596
Unfortunately, that still ultimately exposes the code! It merely restricts access.
597597
If your goal is to distribute a program, for which you want to prevent access
@@ -888,7 +888,7 @@ an environmental variable named `DEBUG_MODE` to `1`. Some contexts
888888
require this in order to allow this mode to work correctly.
889889
You may wish to include your own custom logic within your
890890
program to pivot on this environmental condition as well.
891-
In case you wish to avoid hardcoded referrences for these checks,
891+
In case you wish to avoid hard-coded references for these checks,
892892
the library includes the following constants:
893893

894894
DEBUG_ENV_VAR_NAME
@@ -1054,7 +1054,7 @@ is not specified, the path is re resolved relative to `THIS_DIR`
10541054

10551055
Use this to build paths which will be utilized by QtIFW scripts
10561056
(directly or indirectly) on a target machine. The paths will be
1057-
joined (and used) in a platform agonistic manner.
1057+
joined (and used) in a platform agnostic manner.
10581058

10591059
Note, use `joinPath` to build paths in a platform specific manner,
10601060
applicable to where a build script will be employing it to *create*
@@ -1151,7 +1151,7 @@ normally have a ".app" extension (vs none when they do not have
11511151
a GUI). That additional logic is applied when `isGui` is `True`.
11521152
When `isPathPreserved` is `True`, the entire path is returned rather
11531153
than only the file name. When `False` (the default) a full path
1154-
is stripped down to the basename.
1154+
is stripped down to the base name.
11551155

11561156
### normIconName
11571157

@@ -1166,7 +1166,7 @@ For Linux desktops, however, it is common place to use external ".png" files
11661166
to create icons which point to binaries.
11671167
When `isPathPreserved` is `True`, the entire path is returned rather
11681168
than only the file name. When `False` (the default) a full path
1169-
is stripped down to the basename.
1169+
is stripped down to the base name.
11701170

11711171
### getEnv, setEnv, delEnv
11721172

0 commit comments

Comments
 (0)