Skip to content

Commit

Permalink
Fix a review comments on special methods [skip appveyor]
Browse files Browse the repository at this point in the history
Signed-off-by: Mats Wichmann <[email protected]>
  • Loading branch information
mwichmann committed Dec 22, 2024
1 parent 3ee18c0 commit d6f0887
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
8 changes: 6 additions & 2 deletions doc/user/builders-commands.xml
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,10 @@ env.Command('${SOURCE.base}.out', File('foo.in'), build)

</para>

<tip><para>
<tip>
<title>Sidebar: Node Special Attributes</title>

<para>

The example uses a <firstterm>Node special attribute</firstterm>
(<literal>.base</literal>, the file without its suffix),
Expand All @@ -184,7 +187,8 @@ env.Command('${SOURCE.base}.out', File('foo.in'), build)
(see <xref linkend="sect-creating-nodes"/>),
which is the approach used in the example.

</para></tip>
</para>
</tip>

<para>

Expand Down
8 changes: 5 additions & 3 deletions doc/user/environments.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1876,6 +1876,8 @@ env = Environment()
env.Command('foo', [], '__ROOT__/usr/bin/printenv.py')
</file>
<file name="__ROOT__/usr/bin/printenv.py" chmod="0o755">
#!/usr/bin/env python
import os
import sys
Expand Down Expand Up @@ -2133,7 +2135,7 @@ env.SomeTool(targets, sources)
</para>

<sconstruct>
# For Windows based on the python version and install directory, this may be something like
# For Windows based on the Python version and install directory, this may be something like
C:\Python35\Lib\site-packages\someinstalledpackage\SomeTool.py
C:\Python35\Lib\site-packages\someinstalledpackage\SomeTool\__init__.py

Expand Down Expand Up @@ -2172,10 +2174,10 @@ env.SomeTool(targets, sources)
To avoid the use of a prefix within the name of the tool or filtering
<varname>sys.path</varname> for directories,
we can use &f-link-PyPackageDir; function to locate the directory of
the python package.
the &Python; package.
&f-PyPackageDir; returns a Dir object which represents the path of the
directory
for the python package / module specified as a parameter.
for the &Python; package / module specified as a parameter.
</para>

<sconstruct>
Expand Down

0 comments on commit d6f0887

Please sign in to comment.