Comment problems

From: David Abrahams (dave_at_[hidden])
Date: 2005-04-29 08:47:12

# A helper rule to get the command to invoke some tool. The rule is
# either passed a user provided command, it which case it checks it
'it is checked'----^^^^^^^^^^^^
Otherwise, "it refers to two different things in this sentence"

# for correctness, 

What determines whether a command is "correct?"

# or it tries to find the tool using it's name, the

Fix the ``multiple "it" referent problem'' here too.

# PATH, and additional path.
# This rule returns the command to be used when invoking the
# tool. If we can't find the tool, a warning is issued.
# If 'path-last' is specified, path is checked after

What is "path?" do you mean "PATH?"

# 'additional-paths'.
rule get-invocation-command ( 
...

# Attempts to find tool (binary) named 'name' in PATH and in
# 'additiona-paths'. 
^----'l'
# If found in path, returns 'name'.

What is "path?" do you mean PATH?

# If found in additional paths, returns full name. If there are
^----'-'

What is "full name?"

# several possibilities, 

What do you mean "several possibilities?"

# returns them all.
# Otherwise, returns empty string.
# If 'path-last' is specified, path is checked after

What is "path?" do you mean "PATH?"

# 'additional-paths'.
rule find-tool ( name : additional-paths * : path-last ? )
...

-- 
Dave Abrahams
Boost Consulting
www.boost-consulting.com