[Python-Dev] Questions/comments on documentation formatting

[Georg Brandl]

Brett Cannon schrieb:

>>>>> 4. The var directive is not working even though the docs list it as a
>>>>> valid directive; so is it still valid and something is broken, or the
>>>>> docs need to be updated?
>>>>
>>>> (First, you're confusing "directive" and "role" which led to some confusion
>>>> on Benjamin's part.)
>>>>
>>>> Where is a "var" role documented? If it is, it is a bug.
>>>
>>> http://docs.python.org/dev/3.0/documenting/markup.html#inline-markup.
>>
>> I assume you're referring to "Variable names are an exception, they should
>> be marked simply with *var*."?  Do you have suggestions how to improve
>> clarity?
>>
> 
> "... variables, including function/method arguments, ...".

Thanks, I've changed it a bit along these lines in r68859.

Georg