add basic documentation, bless generated documentation

Mirtia · Apr 4, 2023 · 79a653a · 79a653a
1 parent d95bd4d
commit 79a653a
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/sumy_summarizer.py b/src/sumy_summarizer.py
@@ -8,9 +8,17 @@
 
 
 class PDFSummarizer(PDFToTextConverter):
+ """
+ A class that can be used to summarize text extracted from a PDF file.
+ Inherits from PDFToTextConverter, which extracts the text from the PDF file.
+
+ Attributes:
+ - LANGUAGE (str): The language to use for summarization. Default is "english".
+ - NUM_SENTENCES (int): The number of sentences to include in the summary. Default is 20.
 
  LANGUAGE = "english"
  NUM_SENTENCES = 20
+ """
 
  def __init__(self, filename) -> None:
  super().__init__(filename)