Added documentation for FIDE module

Clueless-Community · May 17, 2024 · 32b96a3 · 32b96a3
1 parent cdf0b28
commit 32b96a3
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 0 deletions.
diff --git a/dev-documentation.md b/dev-documentation.md
@@ -1415,6 +1415,27 @@ obj = espncricinfo.Espncricinfo()
 | `.get_news()`       | Returns a latest news from ESPNCricinfo.          |
 | `.get_livescores()` | Returns a list of live matches from ESPNCricinfo. |
 
+### FIDE
+
+```python
+from scrape_up import fide
+```
+
+Create an instance of `FIDE` class.
+
+```python
+obj = fide.FIDE()
+```
+
+| Methods                   | Details                                            |
+| ------------------------- | -------------------------------------------------- |
+| `.get_events()`           | Returns all the major chess events of 2024.        |
+| `.get_open_ratings()`     | Returns a list of top 100 open category players.   |
+| `.get_women_ratings()`    | Returns a list of top 100 women category players.  |
+| `.get_juniors_ratings()`  | Returns a list of top 100 juniors category players.|
+| `.get_girls_ratings()`    | Returns a list of top 100 girls category players.  |
+| `.get_news()`             | Returns a list of top chess/fide news.             |
+
 # Magic Bricks
 
 Create an instance of `MagicBricks` class

diff --git a/documentation.md b/documentation.md
@@ -528,6 +528,29 @@ espn = espn.ESPN()
 
 ---
 
+### FIDE
+
+```python
+from scrape_up import fide
+```
+
+Create an instance of `FIDE` class.
+
+```python
+obj = fide.FIDE()
+```
+
+| Methods                   | Details                                            |
+| ------------------------- | -------------------------------------------------- |
+| `.get_events()`           | Returns all the major chess events of 2024.        |
+| `.get_open_ratings()`     | Returns a list of top 100 open category players.   |
+| `.get_women_ratings()`    | Returns a list of top 100 women category players.  |
+| `.get_juniors_ratings()`  | Returns a list of top 100 juniors category players.|
+| `.get_girls_ratings()`    | Returns a list of top 100 girls category players.  |
+| `.get_news()`             | Returns a list of top chess/fide news.             |
+
+---
+
 ### eBay
 
 ```py