Mercurial > public > mercurial-scm > hg
comparison mercurial/extensions.py @ 30306:5581b294f3c6
help: show help for disabled extensions (issue5228)
This patch does not exactly solve issue5228 but it results in a better
condition on this issue. For disabled extensions, we used to parse the
module and get the first occurrences of docstring and then return the first
line of that as an introductory heading of extension. This is what we get
today.
This patch returns the whole docstring of the module as a help for extension,
which is more informative. There are some modules which don't have much
docstring at top level except the heading so those are unaffected by this
change. To follow the existing trend of showing commands either we have to
load the extension or have a very ugly parsing method which don't even assure
correctness.
| author | Pulkit Goyal <7895pulkit@gmail.com> |
|---|---|
| date | Sun, 06 Nov 2016 06:54:31 +0530 |
| parents | 8f54f9b8010d |
| children | c4c51fd0e11d |
comparison
equal
deleted
inserted
replaced
| 30305:af7c60988f6e | 30306:5581b294f3c6 |
|---|---|
| 424 else: | 424 else: |
| 425 doc = _moduledoc(file) | 425 doc = _moduledoc(file) |
| 426 file.close() | 426 file.close() |
| 427 | 427 |
| 428 if doc: # extracting localized synopsis | 428 if doc: # extracting localized synopsis |
| 429 return gettext(doc).splitlines()[0] | 429 return gettext(doc) |
| 430 else: | 430 else: |
| 431 return _('(no help text available)') | 431 return _('(no help text available)') |
| 432 | 432 |
| 433 def disabled(): | 433 def disabled(): |
| 434 '''find disabled extensions from hgext. returns a dict of {name: desc}''' | 434 '''find disabled extensions from hgext. returns a dict of {name: desc}''' |
| 446 | 446 |
| 447 exts = {} | 447 exts = {} |
| 448 for name, path in paths.iteritems(): | 448 for name, path in paths.iteritems(): |
| 449 doc = _disabledhelp(path) | 449 doc = _disabledhelp(path) |
| 450 if doc: | 450 if doc: |
| 451 exts[name] = doc | 451 exts[name] = doc.splitlines()[0] |
| 452 | 452 |
| 453 return exts | 453 return exts |
| 454 | 454 |
| 455 def disabledext(name): | 455 def disabledext(name): |
| 456 '''find a specific disabled extension from hgext. returns desc''' | 456 '''find a specific disabled extension from hgext. returns desc''' |