upstream/mercurial-mirror Files · mercurial/pushkey.py

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.

Durham Goode - - Load All Authors

File last commit:

r22953:b1d694d3 default


                r24098:06754070

default

Download file

             pushkey.py
        
                    54 lines
            
             | 1.6 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / mercurial / pushkey.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # 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.

      import bookmarks, phases, obsolete, encoding

      def _nslist(repo):

          n = {}

          for k in _namespaces:

              n[k] = ""

          if not obsolete.isenabled(repo, obsolete.exchangeopt):

              n.pop('obsolete')

          return n

      _namespaces = {"namespaces": (lambda *x: False, _nslist),

                     "bookmarks": (bookmarks.pushbookmark, bookmarks.listbookmarks),

                     "phases": (phases.pushphase, phases.listphases),

                     "obsolete": (obsolete.pushmarker, obsolete.listmarkers),

                    }

      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)

      encode = encoding.fromlocal

      decode = encoding.tolocal

      def encodekeys(keys):

          """encode the content of a pushkey namespace for exchange over the wire"""

          return '\n'.join(['%s\t%s' % (encode(k), encode(v)) for k, v in keys])

      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')

              result[decode(k)] = decode(v)

          return result

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				# 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.

				import bookmarks, phases, obsolete, encoding

				def _nslist(repo):
				n = {}
				for k in _namespaces:
				n[k] = ""
				if not obsolete.isenabled(repo, obsolete.exchangeopt):
				n.pop('obsolete')
				return n

				_namespaces = {"namespaces": (lambda *x: False, _nslist),
				"bookmarks": (bookmarks.pushbookmark, bookmarks.listbookmarks),
				"phases": (phases.pushphase, phases.listphases),
				"obsolete": (obsolete.pushmarker, obsolete.listmarkers),
				}

				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)

				encode = encoding.fromlocal

				decode = encoding.tolocal

				def encodekeys(keys):
				"""encode the content of a pushkey namespace for exchange over the wire"""
				return '\n'.join(['%s\t%s' % (encode(k), encode(v)) for k, v in keys])

				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')
				result[decode(k)] = decode(v)
				return result