Added links in invalid-name details and attempted to de-dupe double comments from pylint. Also added _ to explicitly disallowed names.

Author: BethanyG

lib/common/.pylintrc

@@ -48,7 +48,7 @@ method-naming-style=snake_case
 inlinevar-naming-style=snake_case
 
 # Include a hint for the correct naming format with invalid-name.
-include-naming-hint=yes
+include-naming-hint=no
 
 # Bad variable names which should always be refused, separated by a comma.
 bad-names=x,
@@ -59,7 +59,8 @@ bad-names=x,
           b,
           j,
           o,
-          z
+          z,
+          _
 
 # Good variable names which should always be accepted, separated by a comma.
 good-names=main,

lib/common/pylint_comments.py

@@ -64,21 +64,26 @@ def generate_pylint_comments(in_path, pylint_spec='/opt/analyzer/lib/common/.pyl
                 continue
 
             if line[2] in {"C0114 missing-module-docstring",
+                           "C0115 missing-class-docstring",
                            "C0116 missing-function-docstring",
                            "C0304 missing-final-newline"}:
 
                 status_type = status_mapping['informational']
             else:
                 status_type = status_mapping[line[0]]
 
-            pylint_comments.append(Comment(type=status_type,
-                                           params={'lineno': line[1],
-                                                   'code': line[2],
-                                                   'message': ', '.join(line[3:]),
-                                                   'bad_code': f'Instead of: \n```python\n{bad}```\n\n' if bad else None,
-                                                   'good_code': f'Try: \n```python\n{good}```\n\n' if good else None,
-                                                   'related_info': related,
-                                                   'details': details},
-                                           comment=f'python.pylint.{line[0]}'))
+            new_comment =  Comment(type=status_type,
+                                   params={'lineno': line[1],
+                                           'code': line[2],
+                                           'message': ', '.join(line[3:]),
+                                           'bad_code': f'Instead of: \n```python\n{bad}```\n\n' if bad else None,
+                                           'good_code': f'Try: \n```python\n{good}```\n\n' if good else None,
+                                           'related_info': related,
+                                           'details': details},
+                                   comment=f'python.pylint.{line[0]}')
+
+
+            if new_comment not in pylint_comments:
+                pylint_comments.append(new_comment)
 
     return pylint_comments

lib/common/pylint_data/messages/invalid-name/details.md

@@ -1,16 +1,4 @@
-By default, Pylint will enforce
+By default, Pylint enforces
 [PEP8](https://peps.python.org/pep-0008)-suggested names.
 
-The following naming suggestions are used for Exercism exercises:
-
-- modules (code files): snake_case
-- constants: UPPER_CASE
-- variables: snake_case (minimum of 3 letters)
-- functions: snake_case
-- arguments: snake_case
-- attributes: snake_case
-- classes: PascalCase
-- class attributes: any (no specific format)
-- class constants: UPPER_CASE
-- class methods: snake_case
-- inline variables and loop variables: snake_case
+For more details on the pitfalls of `_` specifically, see this Stack Overflow [answer](https://stackoverflow.com/a/5893946) and [Underscores in Python](https://shahriar.svbtle.com/underscores-in-python) by Shahriar Tajbakhsh.