Skip to content

Commit a3ddf44

Browse files
committed
docs: standardize section headings in test documentation
1 parent bd68e38 commit a3ddf44

File tree

2 files changed

+28
-49
lines changed

2 files changed

+28
-49
lines changed

docs/SCRAPING_INTEGRATION.md

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This integration adds powerful web scraping capabilities to GoAnime, inspired by the popular `ani-cli` script. It supports multiple anime streaming sources with automatic fallback and enhanced download features.
44

5-
## 🌟 New Features
5+
## New Features
66

77
### Multi-Source Support
88
- **AllAnime.day**: High-quality streams with multiple resolution options
@@ -22,7 +22,7 @@ This integration adds powerful web scraping capabilities to GoAnime, inspired by
2222
- **720p, 1080p, 480p**: Specific resolution selection
2323
- **hls**: HLS/m3u8 streams for better compatibility
2424

25-
## 🚀 Usage Examples
25+
## Usage Examples
2626

2727
### Basic Usage
2828
```bash
@@ -51,7 +51,7 @@ goanime -d --source animefire "naruto" 25
5151
goanime -d --quality best "bleach" 100
5252
```
5353

54-
## 🔧 Technical Implementation
54+
## Technical Implementation
5555

5656
### Architecture Overview
5757
```
@@ -84,21 +84,7 @@ type UnifiedScraper interface {
8484
5. **Error Handling with Fallbacks**
8585
6. **Metadata Extraction**
8686

87-
## 🔄 Migration from ani-cli
8887

89-
This integration brings many features from the popular `ani-cli` bash script:
90-
91-
### Supported ani-cli Features
92-
- [x] Multi-source anime search
93-
- [x] Quality selection (best, worst, specific resolutions)
94-
- [x] Episode range downloads
95-
- [x] HLS/m3u8 stream support
96-
- [x] Subtitle extraction
97-
- [x] Referrer handling for protected streams
98-
- [x] User-agent spoofing
99-
- [ ] Skip intro functionality (planned)
100-
- [ ] Syncplay support (planned)
101-
- [ ] VLC integration (planned)
10288

10389
### Command Equivalents
10490
```bash
@@ -114,7 +100,7 @@ goanime -d -r "anime name" 1-5
114100
goanime -d --quality 720p "anime name" 1
115101
```
116102

117-
## 📋 Configuration
103+
## Configuration
118104

119105
### Environment Variables
120106
```bash
@@ -161,7 +147,7 @@ Enable verbose logging to troubleshoot issues:
161147
goanime --debug -d --source allanime "your anime" 1
162148
```
163149

164-
## 🔮 Future Enhancements
150+
## Future Enhancements
165151

166152
### Planned Features
167153
- [ ] Additional streaming sources
@@ -181,7 +167,7 @@ goanime --debug -d --source allanime "your anime" 1
181167
- [ ] Web UI for remote control
182168
- [ ] Mobile app companion
183169

184-
## 🤝 Contributing
170+
## Contributing
185171

186172
To add a new anime source:
187173

@@ -203,10 +189,3 @@ func (c *NewSourceClient) SearchAnime(query string, options ...interface{}) ([]*
203189
}
204190
```
205191

206-
## 📄 License
207-
208-
This enhanced scraping functionality is part of the GoAnime project and follows the same license terms. The implementation is inspired by `ani-cli` but written from scratch in Go.
209-
210-
---
211-
212-
**Note**: Always respect the terms of service of the streaming sites you're accessing. This tool is for educational purposes and personal use only.

internal/updater/TEST_DOCUMENTATION.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This document describes the comprehensive test suite implemented for the GoAnime
1414

1515
## Tested Functions and Features
1616

17-
### Fully Tested (100% Coverage)
17+
### Fully Tested (100% Coverage)
1818

1919
1. **`isVersionNewer`** - Version comparison logic
2020
- Basic semantic version comparison (major.minor.patch)
@@ -39,7 +39,7 @@ This document describes the comprehensive test suite implemented for the GoAnime
3939
- Unicode character handling
4040
- Empty strings and edge cases
4141

42-
### Well Tested (70%+ Coverage)
42+
### Well Tested (70%+ Coverage)
4343

4444
1. **`copyFile`** - File copying functionality
4545
- Basic file copying with content verification
@@ -56,7 +56,7 @@ This document describes the comprehensive test suite implemented for the GoAnime
5656
- Network timeout scenarios
5757
- Invalid URLs and unreachable servers
5858

59-
### ⚠️ Partially Tested (38% Coverage)
59+
### Partially Tested (38% Coverage)
6060

6161
1. **`replaceExecutable`** - Executable replacement
6262
- Basic replacement functionality (Unix systems)
@@ -65,7 +65,7 @@ This document describes the comprehensive test suite implemented for the GoAnime
6565
- Platform-specific logic partially covered
6666
- Windows-specific tests skipped on non-Windows systems
6767

68-
### Not Tested (0% Coverage)
68+
### Not Tested (0% Coverage)
6969

7070
The following high-level functions are not tested due to complexity and external dependencies:
7171

@@ -132,38 +132,38 @@ The following high-level functions are not tested due to complexity and external
132132

133133
### Windows (Simulated)
134134

135-
- ⚠️ Platform detection logic tested
136-
- ⚠️ Asset matching for .exe files
137-
- Actual Windows file operations skipped
138-
- File locking scenarios not tested
135+
- Platform detection logic tested
136+
- Asset matching for .exe files
137+
- Actual Windows file operations skipped
138+
- File locking scenarios not tested
139139

140140
### macOS (Simulated)
141141

142-
- Platform detection and asset matching
143-
- Universal binary support (arm64/amd64)
144-
- Actual macOS-specific operations not tested
142+
- Platform detection and asset matching
143+
- Universal binary support (arm64/amd64)
144+
- Actual macOS-specific operations not tested
145145

146146
## Error Handling Coverage
147147

148148
### Network Errors
149149

150-
- Invalid URLs
151-
- Connection timeouts
152-
- HTTP error codes (404, 500)
153-
- Network unreachable scenarios
150+
- Invalid URLs
151+
- Connection timeouts
152+
- HTTP error codes (404, 500)
153+
- Network unreachable scenarios
154154

155155
### File System Errors
156156

157-
- Source file not found
158-
- Invalid destination paths
159-
- Permission denied scenarios
160-
- Disk space issues (implicit)
157+
- Source file not found
158+
- Invalid destination paths
159+
- Permission denied scenarios
160+
- Disk space issues (implicit)
161161

162162
### Version Parsing Errors
163163

164-
- Invalid version formats
165-
- Non-numeric version parts
166-
- Empty version strings
164+
- Invalid version formats
165+
- Non-numeric version parts
166+
- Empty version strings
167167

168168
## Test Infrastructure
169169

0 commit comments

Comments
 (0)