Skip to content

Commit 242a687

Browse files
Apply suggestions from code review
minor
1 parent eb2ad79 commit 242a687

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ gitingest --help
125125

126126
### Using Multiple Patterns (CLI)
127127

128-
You can specify multiple patterns to include or exclude files and directories by repeating the respective flags (-e for exclude, -i for include). Patterns use standard shell wildcards.
128+
You can specify multiple patterns to include or exclude files and directories by repeating the respective flags (`-e` for exclude, `-i` for include). Patterns use standard shell wildcards.
129129

130130
```bash
131131
# Example 1: Exclude all log files, temporary files, and the entire 'dist' directory
@@ -135,7 +135,7 @@ gitingest /path/to/your/project -e "*.log" -e "*.tmp" -e "dist/"
135135
gitingest https://github.com/user/repo -i "*.py" -i "*.md"
136136

137137
# Example 3: Exclude test directories and specific config files from the current directory (.)
138-
gitingest . -e "tests/" -e "**/config.dev.json" -e "node_modules/"
138+
gitingest -e "tests/" -e "**/config.dev.json" -e "node_modules/"
139139
```
140140

141141
Remember that exclusion patterns take precedence. If specific include patterns are provided, only files matching those and not matching any exclude pattern will be processed.
@@ -179,11 +179,11 @@ result = asyncio.run(ingest_async("path/to/directory"))
179179

180180
### Advanced Pattern Usage (Python API)
181181

182-
The Python API allows for fine-grained control by combining include_patterns and exclude_patterns. When both are provided:
182+
The Python API allows for fine-grained control by combining `include_patterns` and `exclude_patterns`. When both are provided:
183183

184-
Files/directories are first checked against all exclusion patterns (default built-in patterns + user-provided exclude_patterns). If a match occurs, the item is skipped.
184+
Files/directories are first checked against all exclusion patterns (default built-in patterns + user-provided `exclude_patterns`). If a match occurs, the item is skipped.
185185

186-
If include_patterns are specified, any remaining item must also match at least one of the include patterns to be kept. If include_patterns is None or empty, this step is skipped.
186+
If `include_patterns` are specified, any remaining item must also match at least one of the include patterns to be kept. If `include_patterns` is None or empty, this step is skipped.
187187

188188
```python
189189
# Advanced Python API Example
@@ -229,7 +229,7 @@ async def run_async_ingest():
229229
# asyncio.run(run_async_ingest())
230230
```
231231

232-
This setup ensures that even if src/ contains log files, they will be explicitly removed from the final digest, while only other files directly within src/ are included.
232+
This setup ensures that even if `src/` contains log files, they will be explicitly removed from the final digest, while only other files directly within `src/` are included.
233233

234234
### Jupyter notebook usage
235235

0 commit comments

Comments
 (0)