Some documentation fixes

[obestwalter]

I started reading through our docs, trying to figure out how to make it more accessible, here are some minor fixes, I made while reading through.

[codecov]

Codecov Report

Merging #1019 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1019   +/-   ##
=======================================
  Coverage   70.39%   70.39%           
=======================================
  Files          14       14           
  Lines        3486     3486           
  Branches      465      465           
=======================================
  Hits         2454     2454           
  Misses        971      971           
  Partials       61       61

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fec52fc...989897c. Read the comment docs.

[gaborbernat]

you'll need to fix the linting before this is ready

[obestwalter]

Link fixed ... a lot of other things are going wrong though.

[obestwalter]

3/4 are due to codecov being down atm, Iguess. About the win27 I have no clue.

[gaborbernat]

win27 is test ordering, with no randomisation it always success, will need to figure out and fix it soon.

[gaborbernat]

codecov is highly bugy and unreliable, I've filled in a ticket at them to look at, if they don't get back soon I'll just remove integration with them

[obestwalter]

codecov is highly bugy and unreliable

I am afraid I have to agree. I think the maintainer is a bit snowed under. This trivial PR fixing their docs is hanging around for months now: codecov/codecov-python#151

@nicoddemus - is coveralls doing alright?

[nicoddemus]

coveralls has worked fine, but we have been experiencing problems with codecov, like unable to connect to post coverage results (failing the build) and taking too long to post coverage results. ☹️

[obestwalter]

Looks like moving to coveralls then makes sense ...

[obestwalter]

One last failure that uncovered a bug in the excpetion handling:

2018-09-27T08:47:06.7270595Z Exception in thread Thread-217:
2018-09-27T08:47:06.7271136Z Traceback (most recent call last):
2018-09-27T08:47:06.7271398Z   File "C:\hostedtoolcache\windows\Python\2.7.14\x64\Lib\threading.py", line 801, in __bootstrap_inner
2018-09-27T08:47:06.7271676Z     self.run()
2018-09-27T08:47:06.7271912Z   File "D:\a\1\s\tests\unit\session\test_session.py", line 279, in run
2018-09-27T08:47:06.7272558Z     res.result = cmd("-e", tox_env)
2018-09-27T08:47:06.7272813Z   File "d:\a\1\s\.tox\py\lib\site-packages\tox\_pytestplugin.py", line 86, in run
2018-09-27T08:47:06.7273158Z     main([str(x) for x in argv])
2018-09-27T08:47:06.7273397Z   File "d:\a\1\s\.tox\py\lib\site-packages\tox\session.py", line 48, in main
2018-09-27T08:47:06.7273740Z     retcode = build_session(config).runcommand()
2018-09-27T08:47:06.7274000Z   File "d:\a\1\s\.tox\py\lib\site-packages\tox\_pytestplugin.py", line 81, in run_command
2018-09-27T08:47:06.7274330Z     return prev_run_command(self)
2018-09-27T08:47:06.7274573Z   File "d:\a\1\s\.tox\py\lib\site-packages\tox\session.py", line 451, in runcommand
2018-09-27T08:47:06.7274895Z     return self.subcommand_test()
2018-09-27T08:47:06.7275141Z   File "d:\a\1\s\.tox\py\lib\site-packages\tox\session.py", line 555, in subcommand_test
2018-09-27T08:47:06.7275498Z     venv.package = self.hook.tox_package(session=self, venv=venv)
2018-09-27T08:47:06.7275956Z   File "d:\a\1\s\.tox\py\lib\site-packages\pluggy\hooks.py", line 258, in __call__
2018-09-27T08:47:06.7276270Z     return self._hookexec(self, self._nonwrappers + self._wrappers, kwargs)
2018-09-27T08:47:06.7276509Z   File "d:\a\1\s\.tox\py\lib\site-packages\pluggy\manager.py", line 67, in _hookexec
2018-09-27T08:47:06.7276821Z     return self._inner_hookexec(hook, methods, kwargs)
2018-09-27T08:47:06.7277046Z   File "d:\a\1\s\.tox\py\lib\site-packages\pluggy\manager.py", line 61, in <lambda>
2018-09-27T08:47:06.7277343Z     firstresult=hook.spec_opts.get('firstresult'),
2018-09-27T08:47:06.7277569Z   File "d:\a\1\s\.tox\py\lib\site-packages\pluggy\callers.py", line 201, in _multicall
2018-09-27T08:47:06.7277852Z     return outcome.get_result()
2018-09-27T08:47:06.7278384Z   File "d:\a\1\s\.tox\py\lib\site-packages\pluggy\callers.py", line 77, in get_result
2018-09-27T08:47:06.7278614Z     _reraise(*ex)  # noqa
2018-09-27T08:47:06.7278805Z   File "d:\a\1\s\.tox\py\lib\site-packages\pluggy\callers.py", line 180, in _multicall
2018-09-27T08:47:06.7279156Z     res = hook_impl.function(*args)
2018-09-27T08:47:06.7279356Z   File "d:\a\1\s\.tox\py\lib\site-packages\tox\package.py", line 20, in tox_package
2018-09-27T08:47:06.7279590Z     session.package = get_package(session)
2018-09-27T08:47:06.7279790Z   File "d:\a\1\s\.tox\py\lib\site-packages\tox\package.py", line 38, in get_package
2018-09-27T08:47:06.7279999Z     path = build_package(config, report, session)
2018-09-27T08:47:06.7280317Z   File "d:\a\1\s\.tox\py\lib\site-packages\tox\package.py", line 56, in build_package
2018-09-27T08:47:06.7280530Z     return make_sdist_legacy(report, config, session)
2018-09-27T08:47:06.7280778Z   File "d:\a\1\s\.tox\py\lib\site-packages\tox\package.py", line 80, in make_sdist_legacy
2018-09-27T08:47:06.7280966Z     cwd=config.setupdir,
2018-09-27T08:47:06.7281192Z   File "d:\a\1\s\.tox\py\lib\site-packages\tox\session.py", line 169, in popen
2018-09-27T08:47:06.7281422Z     popen = self._popen(args, cwd, env=env, stdout=stdout, stderr=subprocess.STDOUT)
2018-09-27T08:47:06.7281642Z   File "d:\a\1\s\.tox\py\lib\site-packages\tox\session.py", line 266, in _popen
2018-09-27T08:47:06.7281956Z     env=env,
2018-09-27T08:47:06.7282334Z   File "D:\a\1\s\tests\unit\session\test_session.py", line 275, in popen
2018-09-27T08:47:06.7282712Z     (activity_id, activity_name, kwargs.get("env"), ret, cmd)
2018-09-27T08:47:06.7282933Z UnboundLocalError: local variable 'ret' referenced before assignment

I define ret now before to at least get some sensible output ...