doc updates

This commit is contained in:
Manuel Barkhau 2020-10-03 23:44:38 +00:00
parent 98647519c2
commit f92c7347ae
3 changed files with 20 additions and 3 deletions

View file

@ -23,12 +23,29 @@ The recommended approach to using `pylint-ignore` is:
# Overview
- [W0511: fixme (5x)](#w0511-fixme)
- [W0511: fixme (4x)](#w0511-fixme)
- [W0703: broad-except (1x)](#w0703-broad-except)
# W0511: fixme
## File src/pycalver/v1cli.py - Line 29 - W0511 (fixme)
- `message: TODO (mb 2020-10-03): This codepath is not tested since switch to`
- `author : Manuel Barkhau <mbarkhau@gmail.com>`
- `date : 2020-10-03T23:40:01`
```
23: def update_cfg_from_vcs(cfg: config.Config, all_tags: typ.List[str]) -> config.Config:
...
27: return cfg
28:
> 29: # TODO (mb 2020-10-03): This codepath is not tested since switch to
30: # v2 as default version_pattern.
31: version_tags.sort(reverse=True)
```
## File src/pycalver/vcs.py - Line 80 - W0511 (fixme)
- `message: TODO (mb 2018-11-15): Detect encoding of output? Use chardet?`