Skip to content

Commit fe73629

Browse files
committed
updating documentations
1 parent 8a8d73d commit fe73629

File tree

2 files changed

+22
-20
lines changed

2 files changed

+22
-20
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,19 @@ SonarCloud:
3131

3232
## Key Features
3333

34-
- **File Operations**:
35-
- **CSV, JSON, and Text File Functions**: Create, read, write, and manipulate various file types with ease.
36-
- **Folder Functions**: Create and remove directories, list directory contents, and manage file system operations efficiently.
34+
- **Common Functions**
35+
- **File Operations**:
36+
- **CSV, JSON, and Text File Functions**: Create, read, write, and manipulate various file types with ease.
37+
- **Folder Functions**: Create and remove directories, list directory contents, and manage file system operations efficiently.
3738

38-
- **Logging**:
39-
Comprehensive logging setup using the [Loguru Library]('https://loguru.readthedocs.io/en/stable/overview.html'). Provides extensive customization options for log configuration, including log rotation, retention, and formatting. Includes improvements for multiprocessing environments to ensure log messages are handled correctly across multiple processes.
39+
- **Logging**:
40+
Comprehensive logging setup using the [Loguru Library]('https://loguru.readthedocs.io/en/stable/overview.html'). Provides extensive customization options for log configuration, including log rotation, retention, and formatting. Includes improvements for multiprocessing environments to ensure log messages are handled correctly across multiple processes.
4041

41-
- **Calendar Functions**:
42-
- Convert between month names and numbers seamlessly.
42+
- **Calendar Functions**:
43+
Convert between month names and numbers seamlessly.
4344

44-
- **Pattern Matching**:
45-
- Powerful tools for searching patterns in text using regular expressions.
45+
- **Pattern Matching**:
46+
Powerful tools for searching patterns in text using regular expressions.
4647

4748
- **FastAPI Endpoints**:
4849
- Pre-built endpoints for system health checks, status, and uptime monitoring.
@@ -80,7 +81,7 @@ pip install devsetgo-lib[all]
8081
Here's a quick example to demonstrate how you can use some of the key features of `devsetgo_lib`:
8182

8283
```python
83-
from devsetgo_lib import file_functions, logging_config, patterns, calendar_functions
84+
from devsetgo_lib.common_functions import file_functions, logging_config, patterns, calendar_functions
8485

8586
# File Operations
8687
file_functions.create_sample_files("example", 100)

docs/index.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,19 @@ SonarCloud:
3131

3232
## Key Features
3333

34-
- **File Operations**:
35-
- **CSV, JSON, and Text File Functions**: Create, read, write, and manipulate various file types with ease.
36-
- **Folder Functions**: Create and remove directories, list directory contents, and manage file system operations efficiently.
34+
- **Common Functions**
35+
- **File Operations**:
36+
- **CSV, JSON, and Text File Functions**: Create, read, write, and manipulate various file types with ease.
37+
- **Folder Functions**: Create and remove directories, list directory contents, and manage file system operations efficiently.
3738

38-
- **Logging**:
39-
- Comprehensive logging setup using the `loguru` library. Provides extensive customization options for log configuration, including log rotation, retention, and formatting.
39+
- **Logging**:
40+
Comprehensive logging setup using the [Loguru Library]('https://loguru.readthedocs.io/en/stable/overview.html'). Provides extensive customization options for log configuration, including log rotation, retention, and formatting. Includes improvements for multiprocessing environments to ensure log messages are handled correctly across multiple processes.
4041

41-
- **Calendar Functions**:
42-
- Convert between month names and numbers seamlessly.
42+
- **Calendar Functions**:
43+
Convert between month names and numbers seamlessly.
4344

44-
- **Pattern Matching**:
45-
- Powerful tools for searching patterns in text using regular expressions.
45+
- **Pattern Matching**:
46+
Powerful tools for searching patterns in text using regular expressions.
4647

4748
- **FastAPI Endpoints**:
4849
- Pre-built endpoints for system health checks, status, and uptime monitoring.
@@ -80,7 +81,7 @@ pip install devsetgo-lib[all]
8081
Here's a quick example to demonstrate how you can use some of the key features of `devsetgo_lib`:
8182

8283
```python
83-
from devsetgo_lib import file_functions, logging_config, patterns, calendar_functions
84+
from devsetgo_lib.common_functions import file_functions, logging_config, patterns, calendar_functions
8485

8586
# File Operations
8687
file_functions.create_sample_files("example", 100)

0 commit comments

Comments
 (0)