Skip to content

Commit 271f008

Browse files
committed
Refine comments in code examples for clarity and consistency across documentation
1 parent 24cfa5b commit 271f008

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

docs/ai-dev-introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -498,10 +498,10 @@ Step 3 - VS Code Setup (2 minutes):
498498
#### 🎯 **15-Minute First Experience**
499499
500500
```java
501-
// 🎯 Try This: Create a new file and type this comment
501+
// Try This: Create a new file and type this comment
502502
// Create a REST API controller for user management with CRUD operations
503503

504-
/* 🤖 AI will suggest something like this: */
504+
/* AI will suggest something like this: */
505505
@RestController
506506
@RequestMapping("/api/users")
507507
public class UserController {

docs/complete_workshop_guide.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1180,7 +1180,7 @@ public class StringPerformanceComparison {
11801180
// Test StringBuilder
11811181
long stringBuilderTime = testStringBuilder(testData);
11821182
1183-
// 📈 Performance analysis
1183+
// Performance analysis
11841184
double improvement = (double) stringConcatTime / stringBuilderTime;
11851185
System.out.printf("StringBuilder is %.2fx faster%n", improvement);
11861186
}
@@ -1284,7 +1284,7 @@ public class DatabaseExample {
12841284
return null;
12851285
}
12861286
1287-
// 📋 Simple User class
1287+
// Simple User class
12881288
static class User {
12891289
String username, email;
12901290
User(String username, String email) {
@@ -1337,7 +1337,7 @@ class DatabaseExample
13371337
return null;
13381338
}
13391339
1340-
// 📋 Simple User class
1340+
// Simple User class
13411341
public class User
13421342
{
13431343
public string Username { get; set; }
@@ -1359,9 +1359,9 @@ class DatabaseExample
13591359

13601360
#### 🚨 Understanding the Vulnerability
13611361

1362-
**💬 Ask Copilot Chat:**
1362+
**Ask Copilot Chat:**
13631363
```
1364-
🔍 Analyze this code for security vulnerabilities:
1364+
Analyze this code for security vulnerabilities:
13651365
[paste your code here]
13661366

13671367
Focus on:
@@ -1402,9 +1402,9 @@ username = "' UNION SELECT password, credit_card FROM sensitive_data --"
14021402

14031403
#### ✅ AI-Suggested Security Fixes
14041404

1405-
**💬 Ask AI:**
1405+
**Ask AI:**
14061406
```
1407-
🔧 Fix the SQL injection vulnerability using parameterized queries.
1407+
Fix the SQL injection vulnerability using parameterized queries.
14081408
Also add proper input validation and error handling.
14091409
```
14101410

@@ -1562,9 +1562,9 @@ class SecureDatabaseExample
15621562
15631563
#### 🎯 Advanced Input Validation
15641564

1565-
**💬 Ask AI:**
1565+
**Ask AI:**
15661566
```
1567-
🔧 Add comprehensive input validation that includes:
1567+
Add comprehensive input validation that includes:
15681568
1. Null and empty checks
15691569
2. Length restrictions
15701570
3. Character whitelist validation

docs/troubleshooting_guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -563,10 +563,10 @@ class EnterpriseAIDiagnostics:
563563
for agent_name, agent_func in self.diagnostic_agents.items():
564564
try:
565565
results[agent_name] = agent_func()
566-
print(f"{agent_name.title()} diagnostics completed")
566+
print(f"{agent_name.title()} diagnostics completed")
567567
except Exception as e:
568568
results[agent_name] = {'error': str(e)}
569-
print(f"{agent_name.title()} diagnostics failed: {e}")
569+
print(f"{agent_name.title()} diagnostics failed: {e}")
570570
571571
return results
572572
@@ -643,7 +643,7 @@ Network Security:
643643
#!/bin/bash
644644
# Reference: ../resources/cleanup-azure-infrastructure.sh
645645
646-
echo "🚀 Starting enterprise AI performance optimization..."
646+
echo "Starting enterprise AI performance optimization..."
647647
648648
# 1. Check AI service health
649649
curl -s https://api.github.com/copilot/status
@@ -655,7 +655,7 @@ docker stats --format "table {{.Name}}\t{{.CPUPerc}}\t{{.MemUsage}}"
655655
# See ../resources/cleanup-azure-infrastructure.sh for detailed cleanup
656656
657657
# 4. Generate performance report
658-
echo "📊 Performance optimization completed"
658+
echo "Performance optimization completed"
659659
```
660660
661661
---

0 commit comments

Comments
 (0)