doc updates

pylint-ignore.md

@@ -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?`

src/pycalver/v1cli.py

@@ -26,6 +26,8 @@ def update_cfg_from_vcs(cfg: config.Config, all_tags: typ.List[str]) -> config.C
         logger.debug("no vcs tags found")
         return cfg
 
+    # TODO (mb 2020-10-03): This codepath is not tested since switch to
+    #   v2 as default version_pattern.
     version_tags.sort(reverse=True)
     _debug_tags = ", ".join(version_tags[:3])
     logger.debug(f"found tags: {_debug_tags} ... ({len(version_tags)} in total)")

src/pycalver/v2version.py

@@ -414,7 +414,6 @@ def _format_segment_tree(
     segtree    : SegmentTree,
     part_values: PartValues,
 ) -> FormatedSeg:
-    # print("??>>>", seg_tree)
     # NOTE (mb 2020-10-02): starting from the right, if there is any non-zero
     #   part, all further parts going left will be used. In other words, a part
     #   is only omitted, if all parts to the right of it were also omitted.
@@ -432,7 +431,6 @@ def _format_segment_tree(
             is_zero = is_zero and formatted_seg.is_zero
             result_parts.append(formatted_seg.result)
 
-    # print("<<<<", is_zero, result_parts)
     result = "" if is_zero else "".join(result_parts)
     return FormatedSeg(False, is_zero, result)