sapling/doc
Jun Wu f1c575a099 flake8: enable F821 check
Summary:
This check is useful and detects real errors (ex. fbconduit).  Unfortunately
`arc lint` will run it with both py2 and py3 so a lot of py2 builtins will
still be warned.

I didn't find a clean way to disable py3 check. So this diff tries to fix them.
For `xrange`, the change was done by a script:

```
import sys
import redbaron

headertypes = {'comment', 'endl', 'from_import', 'import', 'string',
               'assignment', 'atomtrailers'}

xrangefix = '''try:
    xrange(0)
except NameError:
    xrange = range

'''

def isxrange(x):
    try:
        return x[0].value == 'xrange'
    except Exception:
        return False

def main(argv):
    for i, path in enumerate(argv):
        print('(%d/%d) scanning %s' % (i + 1, len(argv), path))
        content = open(path).read()
        try:
            red = redbaron.RedBaron(content)
        except Exception:
            print('  warning: failed to parse')
            continue
        hasxrange = red.find('atomtrailersnode', value=isxrange)
        hasxrangefix = 'xrange = range' in content
        if hasxrangefix or not hasxrange:
            print('  no need to change')
            continue

        # find a place to insert the compatibility  statement
        changed = False
        for node in red:
            if node.type in headertypes:
                continue
            # node.insert_before is an easier API, but it has bugs changing
            # other "finally" and "except" positions. So do the insert
            # manually.
            # # node.insert_before(xrangefix)
            line = node.absolute_bounding_box.top_left.line - 1
            lines = content.splitlines(1)
            content = ''.join(lines[:line]) + xrangefix + ''.join(lines[line:])
            changed = True
            break

        if changed:
            # "content" is faster than "red.dumps()"
            open(path, 'w').write(content)
            print('  updated')

if __name__ == "__main__":
    sys.exit(main(sys.argv[1:]))
```

For other py2 builtins that do not have a py3 equivalent, some `# noqa`
were added as a workaround for now.

Reviewed By: DurhamG

Differential Revision: D6934535

fbshipit-source-id: 546b62830af144bc8b46788d2e0fd00496838939
2018-04-13 21:51:09 -07:00
..
fb-hgext fb-hgext: move docs 2018-01-10 08:44:04 -08:00
hggit hggit: internalize extension 2018-01-09 06:08:01 -08:00
hgsql hgsql: integrate with hg-crew 2018-01-04 07:22:19 -08:00
hgsubversion hgsuversion: move docs and tools 2018-01-10 16:20:15 -08:00
remotenames remotenames: drop the dir and do some cleanup 2018-01-10 09:01:52 -08:00
check-seclevel.py check-seclevel: skip checking extensions that cannot be imported 2018-01-08 14:34:05 -08:00
docchecker fb-hgext: fix gendoc-related issues 2018-01-09 03:44:33 -08:00
gendoc.py gendoc: fix doc generation to use extensions from repository 2018-01-09 04:29:10 -08:00
hgmanpage.py flake8: enable F821 check 2018-04-13 21:51:09 -07:00
Makefile build: make install in "/doc" failed if the destination dir contained spaces 2017-10-11 01:19:48 +02:00
README doc/README: simplify instructions 2009-09-03 21:40:45 +02:00
runrst doc: translate from :hg:help config.SECTION to a valid link to hgrc.5.html 2016-02-11 23:15:34 +09:00
style.css urls: bulk-change primary website URLs 2015-09-30 15:43:49 -05:00

Mercurial's documentation is kept in reStructuredText format, which is
a simple plain text format that's easy to read and edit:

  http://docutils.sourceforge.net/rst.html

It's also convertible to a variety of other formats including standard
UNIX man page format and HTML. You'll need to install Docutils:

  http://docutils.sourceforge.net/

Use the Makefile in this directory to generate the man and HTML pages.