Skip to content

Commit 519fe15

Browse files
thomas-manginclaude
andcommitted
Docs: Complete xxx-cleanup → comment-cleanup, mark all phases done
- Rename plan/xxx-cleanup/ to plan/comment-cleanup/ - Mark Phase 4 (API Design) complete: 4/4 resolved - Mark Phase 5 (Investigation) complete: 6/6 resolved - Update all references across plan/ and .claude/ directories All XXX comments have been addressed through implementation, documentation, or verification that current design is correct. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 4293613 commit 519fe15

File tree

10 files changed

+34
-32
lines changed

10 files changed

+34
-32
lines changed

.claude/DOCUMENTATION_PLACEMENT_GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ plan/ # Project root
125125
├── coverage.md # Test coverage audit
126126
├── python312-buffer-protocol.md # Future: Python 3.12 + memoryview
127127
├── type-annotations/ # Type annotation detailed plans
128-
└── xxx-cleanup/ # XXX comment cleanup
128+
└── comment-cleanup/ # XXX comment cleanup (✅ Complete)
129129
```
130130

131131
**Format:**

.claude/PLANNING_GUIDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ plan/ # Project root
1515
├── coverage.md # Test coverage audit
1616
├── python312-buffer-protocol.md # Future: Python 3.12 + memoryview
1717
├── type-annotations/ # Type annotation detailed plans
18-
└── xxx-cleanup/ # XXX comment cleanup
18+
└── comment-cleanup/ # XXX comment cleanup (✅ Complete)
1919
```
2020

2121
**Naming:** Lowercase with hyphens: `type-annotations/`, `python312-buffer-protocol.md`

.claude/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Central tracking for all quality improvement work:
168168
- `plan/packed-attribute.md` - Packed-bytes-first refactoring waves
169169
- `plan/coverage.md` - Test coverage audit
170170
- `plan/type-annotations/` - Type annotation detailed plans
171-
- `plan/xxx-cleanup/` - XXX comment cleanup
171+
- `plan/comment-cleanup/` - XXX comment cleanup (✅ Complete)
172172

173173
---
174174

.claude/docs/INDEX.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
- `plan/packed-attribute.md` - Packed-bytes-first refactoring waves
6666
- `plan/coverage.md` - Test coverage audit
6767
- `plan/type-annotations/` - Type annotation detailed plans
68-
- `plan/xxx-cleanup/` - XXX comment cleanup (Phases 4-5 pending)
68+
- `plan/comment-cleanup/` - XXX comment cleanup (✅ Complete)
6969

7070
### Completed Projects (`.claude/docs/projects/` - 50+ files)
7171

.claude/docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Project documentation for completed work, historical development, and reference
1919
- `plan/packed-attribute.md` - Packed-bytes-first refactoring
2020
- `plan/coverage.md` - Test coverage audit
2121
- `plan/type-annotations/` - Type annotation detailed plans
22-
- `plan/xxx-cleanup/` - XXX comment cleanup
22+
- `plan/comment-cleanup/` - XXX comment cleanup (✅ Complete)
2323

2424
---
2525

plan/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ plan/
2323
│ ├── README.md
2424
│ └── *.md
2525
26-
├── xxx-cleanup/ # XXX comment resolution
26+
├── comment-cleanup/ # XXX comment resolution (✅ Complete)
2727
│ ├── README.md
2828
│ └── TODO.md
2929

plan/code-quality.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Status:** 📋 Planning (low priority)
44
**Priority:** Low
5-
**See also:** `type-safety/`, `xxx-cleanup/`
5+
**See also:** `type-safety/`, `comment-cleanup/`
66

77
## Goal
88

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# XXX Comment Cleanup
22

3-
**Status:** 🔄 Active
3+
**Status:** ✅ Complete
44

55
## Overview
66

@@ -30,4 +30,4 @@ See `TODO.md` for:
3030

3131
---
3232

33-
**Last Updated:** 2025-11-30
33+
**Last Updated:** 2025-12-04
Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# XXX Comment Cleanup - TODO
22

3-
**Status:** Partial - Phase 1-3 complete, 2 resolved + 1 reopened during audit
3+
**Status:** ✅ COMPLETE - All phases resolved
44
**Started:** 2025-11-25
55
**Updated:** 2025-12-04
66

@@ -101,43 +101,42 @@
101101
- **Action:** Make CODE non-instantiable, update usages
102102

103103
### 4.3 VPLS signature alignment
104-
- **File:** `src/exabgp/bgp/message/update/nlri/vpls.py:71-107`
105-
- **Status:** REOPENED - XXX removed but issue persists
106-
- **Issue:** `make_vpls()` missing `action` and `addpath` params that other NLRIs have (INET, IPVPN, EVPN, Flow)
107-
- **Action:** Add `action: Action = Action.ANNOUNCE` and `addpath: PathInfo = PathInfo.DISABLED` to `make_vpls()`
104+
- **File:** `src/exabgp/bgp/message/update/nlri/vpls.py:73-105`
105+
- **Status:** ✅ RESOLVED - `make_vpls()` has `action` and `addpath` params
106+
- **Also:** `make_empty()` factory method added with same params (lines 107-125)
108107

109108
### 4.4 TrafficNextHopSimpson inheritance
110-
- **File:** `src/exabgp/bgp/message/update/attribute/community/extended/traffic.py:277`
111-
- **Status:** Pending
112-
- **Action:** Make subclass of NextHop or IP
109+
- **File:** `src/exabgp/bgp/message/update/attribute/community/extended/traffic.py:282-304`
110+
- **Status:** ✅ RESOLVED - No change needed
111+
- **Analysis:** Current design is correct. TrafficNextHopSimpson is an ExtendedCommunity (not NextHop/IP) because it doesn't contain an IP address - it only signals "use the UPDATE's existing NextHop" with a copy flag. Inheriting from NextHop or IP would be semantically wrong.
113112

114113
---
115114

116-
## Phase 5: Investigation Required - NOT STARTED
115+
## Phase 5: Investigation Required - ✅ COMPLETE
117116

118117
### 5.1 VPLS unique key
119-
- **File:** `src/exabgp/bgp/message/update/nlri/vpls.py:218-219`
120-
- **Status:** Pending investigation
118+
- **File:** `src/exabgp/bgp/message/update/nlri/vpls.py:237-240`
119+
- **Status:** ✅ RESOLVED - XXX removed, unique key = all fields (rd, endpoint, base, offset, size) documented
121120

122121
### 5.2 RTC variable length prefixing
123-
- **File:** `src/exabgp/bgp/message/update/nlri/rtc.py:37`
124-
- **Status:** Pending investigation
122+
- **File:** `src/exabgp/bgp/message/update/nlri/rtc.py:30-38`
123+
- **Status:** ✅ RESOLVED - XXX removed, limitation documented in docstring (RFC 4684 prefix filtering not implemented)
125124

126125
### 5.3 EVPN MAC index
127-
- **File:** `src/exabgp/bgp/message/update/nlri/evpn/mac.py:132`
128-
- **Status:** Pending investigation
126+
- **File:** `src/exabgp/bgp/message/update/nlri/evpn/mac.py:132-138`
127+
- **Status:** ✅ RESOLVED - XXX removed, design documented: index() uses full bytes, __eq__() uses RFC key fields
129128

130129
### 5.4 SRCAP redundant parsing
131-
- **File:** `src/exabgp/bgp/message/update/attribute/bgpls/node/srcap.py:92`
132-
- **Status:** Pending investigation
130+
- **File:** `src/exabgp/bgp/message/update/attribute/bgpls/node/srcap.py:88-91`
131+
- **Status:** ✅ RESOLVED - XXX removed, offset calculation (7 = 3 range + 4 header) is correct, not redundant
133132

134133
### 5.5 PMSI length discrepancy
135134
- **File:** `src/exabgp/bgp/message/update/attribute/pmsi.py:90`
136135
- **Status:** ✅ RESOLVED - XXX comment no longer exists
137136

138137
### 5.6 BGP-LS IGP tags LEN checks
139138
- **Files:** `igpextags.py:31`, `igptags.py:34`
140-
- **Status:** Pending investigation
139+
- **Status:** ✅ RESOLVED - XXX removed, cls.check(data) validates length, comments document expected format
141140

142141
---
143142

@@ -152,6 +151,9 @@
152151
| 2025-11-25 | Phase 3 implementation | Caching init removed, comments clarified |
153152
| 2025-11-25 | All tests pass | Ready for commit |
154153
| 2025-12-04 | Validation audit | 2 resolved (4.1, 5.5), 4.3 reopened (make_vpls needs action/addpath), line numbers updated |
154+
| 2025-12-04 | Recheck 4.3 | 4.3 resolved - make_vpls() has action/addpath params |
155+
| 2025-12-04 | Investigate 4.4 | 4.4 resolved - current design correct, no inheritance change needed |
156+
| 2025-12-04 | Investigate Phase 5 | All 6 items resolved - XXX comments replaced with documentation in commit c948819c |
155157

156158
---
157159

plan/todo.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -130,12 +130,12 @@ Migrate to Python 3.12+ and use `memoryview` for zero-copy parsing.
130130

131131
---
132132

133-
### XXX Cleanup (Phases 4-5)
133+
### XXX Cleanup
134134

135-
**See:** `plan/xxx-cleanup/`
135+
**See:** `plan/comment-cleanup/`
136136

137-
- [ ] Phase 4: API Design Issues
138-
- [ ] Phase 5: Investigation Required
137+
- [x] Phase 4: API Design Issues
138+
- [x] Phase 5: Investigation Required
139139

140140
---
141141

@@ -155,7 +155,7 @@ All plans in `plan/` directory:
155155
| `architecture.md` | 📋 Planning | Circular dependency fixes |
156156
| `code-quality.md` | 📋 Planning | Misc improvements |
157157
| `family-tuple.md` | 📋 Planning | FamilyTuple type alias |
158-
| `xxx-cleanup/` | 🔄 Active | XXX comment resolution |
158+
| `comment-cleanup/` | ✅ Complete | XXX comment resolution |
159159

160160
---
161161

0 commit comments

Comments
 (0)