##// END OF EJS Templates
help: teach topic symbols how to dedent...
help: teach topic symbols how to dedent When using docstrings for documenting symbols such as revsets, templates, or hgweb commands, documentation likely has leading whitespace corresponding to the indentation from the Python source file. Up until this point, the help system stripped all leading and trailing whitespace and replaced it with 2 spaces of leading whitespace. There were a few bad side-effects. First, sections could not be used in docstrings because they would be indented and the rst parser would fail to parse them as sections. Also, any rst elements that required indentation would lose their indentation, again causing them to be parsed and rendered incorrectly. In this patch, we teach the topic symbols system how to dedent text properly. I argue this mode should be enabled by default. However, I stopped short of changing that because it would cause a lot of documentation reformatting to occur. I'm not sure if people are relying on or wanting indentation. So, dedenting has only been turned on for hgweb symbols. This decision should be scrutinized.

File last commit:

r22953:b1d694d3 default
r24098:06754070 default
Show More
pushkey.py
54 lines | 1.6 KiB | text/x-python | PythonLexer
Matt Mackall
pushkey: add pushkey core
r11367 # pushkey.py - dispatching for pushing and pulling keys
#
# Copyright 2010 Matt Mackall <mpm@selenic.com>
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version.
Pierre-Yves David
pushkey: introduce an ``encodekeys`` function...
r21650 import bookmarks, phases, obsolete, encoding
Matt Mackall
bookmarks: move pushkey functions into core
r13353
Matt Mackall
pushkey: add pushkey core
r11367 def _nslist(repo):
n = {}
for k in _namespaces:
n[k] = ""
Durham Goode
obsolete: add exchange option...
r22953 if not obsolete.isenabled(repo, obsolete.exchangeopt):
Pierre-Yves David
pushkey: do not exchange obsole markers if feature is disabled...
r17298 n.pop('obsolete')
Matt Mackall
pushkey: add pushkey core
r11367 return n
Matt Mackall
bookmarks: move pushkey functions into core
r13353 _namespaces = {"namespaces": (lambda *x: False, _nslist),
Pierre-Yves David
phases: add basic pushkey support
r15648 "bookmarks": (bookmarks.pushbookmark, bookmarks.listbookmarks),
"phases": (phases.pushphase, phases.listphases),
Pierre-Yves.David@ens-lyon.org
obsolete: exchange obsolete marker over pushkey...
r17075 "obsolete": (obsolete.pushmarker, obsolete.listmarkers),
Pierre-Yves David
phases: add basic pushkey support
r15648 }
Matt Mackall
pushkey: add pushkey core
r11367
def register(namespace, pushkey, listkeys):
_namespaces[namespace] = (pushkey, listkeys)
def _get(namespace):
return _namespaces.get(namespace, (lambda *x: False, lambda *x: {}))
def push(repo, namespace, key, old, new):
'''should succeed iff value was old'''
pk = _get(namespace)[0]
return pk(repo, key, old, new)
def list(repo, namespace):
'''return a dict'''
lk = _get(namespace)[1]
return lk(repo)
Pierre-Yves David
pushkey: add an ``encode`` function...
r21661 encode = encoding.fromlocal
Pierre-Yves David
pushkey: add a ``decode`` function...
r21659 decode = encoding.tolocal
Pierre-Yves David
pushkey: introduce an ``encodekeys`` function...
r21650 def encodekeys(keys):
"""encode the content of a pushkey namespace for exchange over the wire"""
Pierre-Yves David
pushkey: add an ``encode`` function...
r21661 return '\n'.join(['%s\t%s' % (encode(k), encode(v)) for k, v in keys])
Pierre-Yves David
pushkey: introduce an ``decodekeys`` function...
r21652
def decodekeys(data):
"""decode the content of a pushkey namespace from exchange over the wire"""
result = {}
for l in data.splitlines():
k, v = l.split('\t')
Pierre-Yves David
pushkey: add a ``decode`` function...
r21659 result[decode(k)] = decode(v)
Pierre-Yves David
pushkey: introduce an ``decodekeys`` function...
r21652 return result