Skip to content

Commit 4cd5ef2

Browse files
committed
add docstring files
1 parent 11ae717 commit 4cd5ef2

11 files changed

+17
-15
lines changed

scrapegraphai/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
"""
2-
__init__.py file for scrapegraphai folder
2+
__init__.py file for scrapegraphai folder
33
"""

scrapegraphai/builders/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
__init__.py file for builders folder
2+
This module contains the builders for constructing various components in the ScrapeGraphAI application.
33
"""
44

55
from .graph_builder import GraphBuilder

scrapegraphai/docloaders/__init__.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
"""__init__.py file for docloaders folder"""
1+
"""
2+
This module handles document loading functionalities for the ScrapeGraphAI application.
3+
"""
24

35
from .chromium import ChromiumLoader
46
from .browser_base import browser_base_fetch

scrapegraphai/graphs/__init__.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
"""
2-
__init__.py file for graphs folder
1+
"""
2+
This module defines the graph structures and related functionalities for the ScrapeGraphAI application.
33
"""
44

55
from .abstract_graph import AbstractGraph

scrapegraphai/graphs/document_scraper_graph.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
md_scraper module
2+
This module implements the Document Scraper Graph for the ScrapeGraphAI application.
33
"""
44
from typing import Optional
55
import logging

scrapegraphai/graphs/omni_scraper_graph.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
OmniScraperGraph Module
2+
This module implements the Omni Scraper Graph for the ScrapeGraphAI application.
33
"""
44
from typing import Optional
55
from pydantic import BaseModel

scrapegraphai/helpers/__init__.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
"""
2-
__init__.py for the helpers folder
1+
"""
2+
This module provides helper functions and utilities for the ScrapeGraphAI application.
33
"""
44
from .nodes_metadata import nodes_metadata
55
from .schemas import graph_schema

scrapegraphai/models/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
__init__.py file for models folder
2+
This module contains the model definitions used in the ScrapeGraphAI application.
33
"""
44
from .openai_itt import OpenAIImageToText
55
from .openai_tts import OpenAITextToSpeech

scrapegraphai/nodes/base_node.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
"""
2-
BaseNode Module
1+
"""
2+
This module defines the base node class for the ScrapeGraphAI application.
33
"""
44
import re
55
from abc import ABC, abstractmethod

scrapegraphai/nodes/fetch_node.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
""""
1+
"""
22
FetchNode Module
33
"""
44
import json
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
"""
2-
description node prompts
2+
This module contains prompts for description nodes in the ScrapeGraphAI application.
33
"""
44

55
DESCRIPTION_NODE_PROMPT = """
66
You are a scraper and you have just scraped the
77
following content from a website. \n
88
Please provide a description summary of maximum of 20 words. \n
99
CONTENT OF THE WEBSITE: {content}
10-
"""
10+
"""

0 commit comments

Comments
 (0)