Updated documentation

Anshika14528 · May 18, 2024 · 0d92a28 · 0d92a28
1 parent 08d6350
commit 0d92a28
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 4 deletions.
diff --git a/dev-documentation.md b/dev-documentation.md
@@ -1745,3 +1745,20 @@ atcode.get_profile()
 | `.get_profile()` | Returns the user data in json format. |
 
 ---
+
+## Pinterest
+
+First create an object of class `Pinterest`.
+
+```python
+from scrap_up import Pinterest
+
+pinterest = Pinterest()
+```
+
+| Methods                     | Details                                                      |
+| --------------------------- | ------------------------------------------------------------ |
+| `.get_today()`              | Returns the list of today's topics                           |
+| `.get_photo(your_url)`      | Returns the link to the image (so you don't need an account) |
+| `.search_pins(keyword)`     | Search for pins containing a specific keyword on Pinterest   |
+| `.get_pin_details(pin_url)` | Fetch details about a specific pin on Pinterest              |
diff --git a/src/scrape_up/pinterest/pinterest.py b/src/scrape_up/pinterest/pinterest.py
@@ -5,10 +5,10 @@
 class Pinterest:
     """
     Create an instance of `Pinterest` class.
-     ```python
-     pinterest = Pinterest()
-     ```
-     | Methods                | Details                                                            |
+    ```python
+    pinterest = Pinterest()
+    ```
+    | Methods                | Details                                                            |
     | ---------------------- | ------------------------------------------------------------------ |
     | `.get_today()`         | Returns the list of today's topics                                  |
     | `.get_photo(your_url)` | Returns the link to the image (so you don't need an account)        |