Tatsh / wiswa / 25069337693

100%

push

github

utils.github: drop module-wide promise from session docstring

The session parameter docstring on get_github_pages_build_type
previously claimed auth headers are "not mutated on the session", but
_setup_github_session in the same module does exactly that via
session.headers.update(...) and the configure helpers depend on it.
Reword to describe only what this function does (per-request headers
for this call) so the docstring no longer over-promises about
unrelated helpers.

Signed-off-by: Andrew Udvare <audvare@gmail.com>

476 of 476 branches covered (100.0%)

Branch coverage included in aggregate %.

2460 of 2460 relevant lines covered (100.0%)

5.0 hits per line