Tweak some things about Command() docs #4535
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adjust the description of the
Command
function (and builder entry), mainly to try out new terminology. We've said it's not really a builder, but it feels better to me to admit it is exactly a builder call, just not to one of the existing named builders. So the term introduced is "anonymous builder". Changes in docstring forCommand
, too, plus a little tweak to kwarg processing. SinceCommand
refers toBuilder
'starget_factory
andsource_factory
arguments, looked at the examples there, and tweaked them to be a little closer to runnable examples (ideas taken from the testcase, which the examples seem to have been based on originally).This change actually started with reformatting some examples in the manpage, some of which used
Command
, with thechdir
argument which didn't seem to be mentioned in the description of how to useCommand
, which lists four keyword args and says all the rest are treated as construction variable settings (not true forchdir
, which isn't one of the four). That led to thinking about rewording.The original code reformatting changes, no longer directly related to the current change subject, are left in just because they seem low burden, though could back them out if it makes reviewing too hard.
A couple of other small tweaks:
Environment.xml
, which produces shared content, you can't use manpage-specific links, so the textual references needed updating.Configure
used both terms "custom checks" and "custom tests", now only the former; plus a link reference added.Contributor Checklist:
CHANGES.txt
(and read theREADME.rst
)