Merge pull request #14 from tzussman/docs2

Docs fixes
tzussman · May 4, 2023 · 2892ba6 · 2892ba6
2 parents ee28562 + 3033dbc
commit 2892ba6
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,7 @@
 ![GitHub issues](https://img.shields.io/github/issues/tzussman/valparse)
 [![Build Status](https://github.com/tzussman/valparse/workflows/Build%20Status/badge.svg?branch=main)](https://github.com/tzussman/valparse/actions?query=workflow%3A%22Build+Status%22)
 [![codecov](https://codecov.io/gh/tzussman/valparse/branch/main/graph/badge.svg)](https://codecov.io/gh/tzussman/valparse)
+[![Docs](https://img.shields.io/badge/-docs-blueviolet)](https://tzussman.github.io/valparse)
 
 *valparse* supports protocol version 4 with [*Memcheck*][memcheck] only, but can
 be easily modified to support [*Helgrind*][helgrind] and other protocol tools.

diff --git a/docs/documentation.rst b/docs/documentation.rst
@@ -5,5 +5,5 @@ Documentation
    :maxdepth: 2
    :caption: Contents:
 
-.. automodule:: valparse
+.. automodule:: valparse.valparse
     :members:
diff --git a/valparse/valparse.py b/valparse/valparse.py
@@ -453,14 +453,6 @@ def from_xml_element(cls, el: ET.Element) -> 'Suppression':
         return cls(name, kind, stack, auxkind)
 
     def createRawText(self, name: str):
-        """Creates raw text for suppression
-
-        Parameters
-        ----------
-        name : str
-            Name of suppression
-        """
-
         def line(string):
             return f"   {string}\n"
 
@@ -550,13 +542,6 @@ def from_xml_element(cls, el: ET.Element) -> 'FatalSignal':
         return cls(tid, signo, signame, sicode, siaddr, stack, event, threadname)
 
     def get_signal(self) -> signal.Signals:
-        """Returns signal object corresponding to signal name
-
-        Returns
-        -------
-        signal.Signals
-            Signal object
-        """
         return signal.Signals[self.signame]
 
     def __str__(self):