Skip to content

Commit 06115ed

Browse files
use "startIndex" instead of "start" on public API
1 parent dbc1f77 commit 06115ed

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

Sources/Markdown/Block Nodes/Block Container Blocks/OrderedList.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ public extension OrderedList {
3737
/// The default starting index in CommonMark is 1. In this case, clients may use the default
3838
/// ordered-list start index of their desired rendering format. For example, when rendering to
3939
/// HTML, clients may omit the `start` attribute of the rendered list when this returns 1.
40-
var start: UInt {
40+
var startIndex: UInt {
4141
get {
4242
guard case let .orderedList(start) = _data.raw.markup.data else {
4343
fatalError("\(self) markup wrapped unexpected \(_data.raw)")
4444
}
4545
return start
4646
}
4747
set {
48-
guard start != newValue else {
48+
guard startIndex != newValue else {
4949
return
5050
}
5151
_data = _data.replacingSelf(.orderedList(parsedRange: nil, _data.raw.markup.copyChildren(), startIndex: newValue))

Sources/Markdown/Walker/Walkers/MarkupTreeDumper.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,8 @@ struct MarkupTreeDumper: MarkupWalker {
190190
}
191191

192192
mutating func visitOrderedList(_ orderedList: OrderedList) {
193-
if orderedList.start != 1 {
194-
dump(orderedList, customDescription: "start: \(orderedList.start)")
193+
if orderedList.startIndex != 1 {
194+
dump(orderedList, customDescription: "startIndex: \(orderedList.startIndex)")
195195
} else {
196196
defaultVisit(orderedList)
197197
}

Tests/MarkdownTests/Visitors/MarkupFormatterTests.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -149,23 +149,23 @@ class MarkupFormatterSingleElementTests: XCTestCase {
149149
do { // no checkbox
150150
let expected = "2. A list item."
151151
var renderedList = OrderedList(ListItem(Paragraph(Text("A list item."))))
152-
renderedList.start = 2
152+
renderedList.startIndex = 2
153153
let printed = renderedList.format(options: options)
154154
XCTAssertEqual(expected, printed)
155155
}
156156
do { // unchecked
157157
let expected = "2. [ ] A list item."
158158
var renderedList = OrderedList(ListItem(checkbox: .unchecked,
159159
Paragraph(Text("A list item."))))
160-
renderedList.start = 2
160+
renderedList.startIndex = 2
161161
let printed = renderedList.format(options: options)
162162
XCTAssertEqual(expected, printed)
163163
}
164164
do { // checked
165165
let expected = "2. [x] A list item."
166166
var renderedList = OrderedList(ListItem(checkbox: .checked,
167167
Paragraph(Text("A list item."))))
168-
renderedList.start = 2
168+
renderedList.startIndex = 2
169169
let printed = renderedList.format(options: options)
170170
XCTAssertEqual(expected, printed)
171171
}
@@ -944,7 +944,7 @@ class MarkupFormatterLineSplittingTests: XCTestCase {
944944

945945
let expectedTreeDump = """
946946
Document
947-
└─ OrderedList start: 1000
947+
└─ OrderedList startIndex: 1000
948948
└─ ListItem
949949
└─ Paragraph
950950
├─ Text "Really really"

Tests/MarkdownTests/Visitors/MarkupTreeDumperTests.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ final class MarkupTreeDumperTests: XCTestCase {
5555
├─ BlockQuote @13:1-13:13 #38
5656
│ └─ Paragraph @13:3-13:13 #39
5757
│ └─ Text @13:3-13:13 #40 "BlockQuote"
58-
├─ OrderedList @15:1-17:1 #41 start: 2
58+
├─ OrderedList @15:1-17:1 #41 startIndex: 2
5959
│ ├─ ListItem @15:1-15:9 #42
6060
│ │ └─ Paragraph @15:4-15:9 #43
6161
│ │ └─ Text @15:4-15:9 #44 "flour"

0 commit comments

Comments
 (0)