>>>>> "Ian" == Ian Clatworthy <email address hidden> writes:
Ian> John A Meinel wrote:
>> Vincent Ladeuil wrote:
>>> And spit rest bits to the user when doing `bzr help conflict-types` ???
>>
>> Until we fix 'bzr help' we already do that for lots of other ones.
>>
>> 'bzr help init' shows a '::'
>> 'bzr help init-repo' as well
>> 'bzr help diff'
>> 'bzr help log'
>>
>> etc, etc, etc.
>>
>> There is an open bug that we should use a plain-text formatter when
>> writing out ReST code, I'd rather fix that, then not have use use ReST
>> for help which gets translated into our HTML documentation.
Ian> Some limited ReST translations gets done when outputting text help
Ian> currently, e.g.
Ian> :: at the ends of a line gets mapped to :
Ian> :doc:`xxx-help` gets mapped to `bzr help xxx`
Ian> We don't bundle DocTools or Sphinx but it is possible to write text
Ian> that is reasonable in both text output and html output given the rules
Ian> already in place. I'm sure we could tweak them further though.
Ok, so I've tweaked back these changes, I originally revert the
rest changes because, thinking it *was* a rest document, I
embedded some TODO and FIXMEs in the comment which are *not* to
be displayed in a help output.
Now, can I have some *review* on the core of this patch or,
failing that, an agreement that since nobody cares enough and the
changes are unlikely to break anything I can just land it ?
>>>>> "Ian" == Ian Clatworthy <email address hidden> writes:
Ian> John A Meinel wrote:
>> Vincent Ladeuil wrote:
>>> And spit rest bits to the user when doing `bzr help conflict-types` ???
>>
>> Until we fix 'bzr help' we already do that for lots of other ones.
>>
>> 'bzr help init' shows a '::'
>> 'bzr help init-repo' as well
>> 'bzr help diff'
>> 'bzr help log'
>>
>> etc, etc, etc.
>>
>> There is an open bug that we should use a plain-text formatter when
>> writing out ReST code, I'd rather fix that, then not have use use ReST
>> for help which gets translated into our HTML documentation.
Ian> Some limited ReST translations gets done when outputting text help
Ian> currently, e.g.
Ian> :: at the ends of a line gets mapped to :
Ian> :doc:`xxx-help` gets mapped to `bzr help xxx`
Ian> We don't bundle DocTools or Sphinx but it is possible to write text
Ian> that is reasonable in both text output and html output given the rules
Ian> already in place. I'm sure we could tweak them further though.
Ok, so I've tweaked back these changes, I originally revert the
rest changes because, thinking it *was* a rest document, I
embedded some TODO and FIXMEs in the comment which are *not* to
be displayed in a help output.
Now, can I have some *review* on the core of this patch or,
failing that, an agreement that since nobody cares enough and the
changes are unlikely to break anything I can just land it ?
Thanks in advance.