Skip to content

Commit 27e02c7

Browse files
authored
Merge pull request #113 from Adyen/swift-markdown-output
Using swift for markdown output
2 parents d0dfb23 + ade390c commit 27e02c7

File tree

6 files changed

+127
-129
lines changed

6 files changed

+127
-129
lines changed

Sources/PublicModules/PADOutputGenerator/Documentation.docc/PADOutputGenerator.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ _Comparing `old` to `new`_
3333
---
3434
## SomeModule
3535
#### ❇️ Added
36-
```javascript
36+
```swift
3737
public protocol NewProtocol {
3838
var property: String { get }
3939
}
4040
```
4141
#### 🔀 Changed
42-
```javascript
42+
```swift
4343
// From
4444
open class SomeClass : SomeProtocol, OldProtocol
4545

@@ -53,6 +53,6 @@ Changes:
5353
*/
5454
```
5555
#### 😶‍🌫️ Removed
56-
```javascript
56+
```swift
5757
public protocol OldProtocol
5858
```

Sources/PublicModules/PADOutputGenerator/MarkdownOutputGenerator.swift

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,9 +164,7 @@ private extension MarkdownOutputGenerator {
164164

165165
var lines = [title]
166166
changes.sorted { lhs, rhs in description(for: lhs) < description(for: rhs) }.forEach {
167-
// We're using `javascript` as it produces the nicest looking markdown output on Github
168-
// `swift` is available but sometimes produces unexpected syntax highlighting
169-
lines.append("```javascript")
167+
lines.append("```swift")
170168
lines.append(description(for: $0))
171169

172170
if !$0.listOfChanges.isEmpty {

0 commit comments

Comments
 (0)