Merge pull request #1 from stefmolin/patch-2

Add test to ensure that escaping trailing underscores in parameters is accounted for.

Author: stefmolin

numpydoc/tests/test_validate.py

@@ -482,6 +482,29 @@ def valid_options_in_parameter_description_sets(self, bar):
         >>> result = 1 + 1
         """
 
+    def parameters_with_trailing_underscores(self, str_):
+        r"""
+        Ensure PR01 and PR02 errors are not raised with trailing underscores.
+        
+        Parameters with trailing underscores need to escape the them to render
+        properly in the documentation since trailing underscores are used to
+        create links.
+
+        Parameters
+        ----------
+        str\_ : str
+           Some text.
+
+        See Also
+        --------
+        related : Something related.
+
+        Examples
+        --------
+        >>> result = 1 + 1
+        """
+        pass       
+
 
 class BadGenericDocStrings:
     """Everything here has a bad docstring"""