[Scons-users] What is the difference between Variables and Options

William Blevins wblevins001 at gmail.com
Sun Jan 3 10:43:42 EST 2016


Stefan,

Although I understand what you are saying, the User's Guide is pretty long
and dense already, I cannot imagine what it would look like if you tried to
make every artifact completely unambiguous with natural language which is
already ambiguous. If you find specific artifacts that you can word better,
please feel free to make a pull request?

Also you mentioned wanted a search feature. There are versions of the
User's Guide which have the entire document as 1 HTML page; thus, you can
search however you like with any browser, etc.

V/R,
William

On Sun, Jan 3, 2016 at 4:59 AM, Stefan Seefeld <stefan at seefeld.name> wrote:

> On 02.01.2016 20:32, Bill Deegan wrote:
> > Stefan,
> >
> > Cross reference from the user guide should point at the manpage (IMHO)
> > and not the API guide which is mostly internal API's not meant for
> > most developers building a build system using SCons.
>
> Reading the User's Guide I regularly find myself wanting more details
> (e.g., what is the exact signature of a given function / method ?),
> which I'd expect to find an answer to in the API reference. Likewise, I
> often see terms being used that lack a clear definition (and thus are
> prone to ambiguities or misunderstandings, like this "variables" vs.
> "options" point in the other thread, where I think a glossary or
> high-level conceptual overview might be beneficial.
>
> Many other Python tools use Sphinx to generate their documentation,
> which makes the writing of such interconnected sets of docs natural, and
> the result very convenient to use.
>
>         Stefan
>
> --
>
>       ...ich hab' noch einen Koffer in Berlin...
>
> _______________________________________________
> Scons-users mailing list
> Scons-users at scons.org
> https://pairlist4.pair.net/mailman/listinfo/scons-users
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://pairlist4.pair.net/pipermail/scons-users/attachments/20160103/fcd8e1de/attachment.html>


More information about the Scons-users mailing list