Skip to content

Commit de786fc

Browse files
committed
Rename to CrossLinks
1 parent a82df41 commit de786fc

File tree

5 files changed

+21
-21
lines changed

5 files changed

+21
-21
lines changed

docs/source/docset.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,4 @@ toc:
7777
- file: index.md
7878
- file: req.md
7979
- folder: nested
80-
- file: external-links.md
80+
- file: cross-links.md

docs/source/testing/external-links.md renamed to docs/source/testing/cross-links.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: External Links
2+
title: Cross Links
33
---
44

55
[Elasticsearch](elasticsearch://index.md)

src/Elastic.Markdown/Diagnostics/DiagnosticsChannel.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ public class DiagnosticsCollector(ILoggerFactory loggerFactory, IReadOnlyCollect
8787

8888
public HashSet<string> OffendingFiles { get; } = new();
8989

90-
public ConcurrentDictionary<string, bool> ExternalLinks { get; } = new();
90+
public ConcurrentDictionary<string, bool> CrossLinks { get; } = new();
9191

9292
public Task StartAsync(Cancel ctx)
9393
{
@@ -143,7 +143,7 @@ public virtual async Task StopAsync(CancellationToken cancellationToken)
143143
await Channel.Reader.Completion;
144144
}
145145

146-
public void EmitExternalLink(string link) => ExternalLinks.TryAdd(link, true);
146+
public void EmitExternalLink(string link) => CrossLinks.TryAdd(link, true);
147147

148148
public void EmitError(string file, string message, Exception? e = null)
149149
{

src/Elastic.Markdown/IO/LinkReference.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ public record LinkReference
1717
[JsonPropertyName("links")]
1818
public required string[] Links { get; init; } = [];
1919

20-
[JsonPropertyName("external_links")]
21-
public required string[] ExternalLinks { get; init; } = [];
20+
[JsonPropertyName("cross_links")]
21+
public required string[] CrossLinks { get; init; } = [];
2222

2323
public static LinkReference Create(DocumentationSet set)
2424
{
25-
var externalLinks = set.Context.Collector.ExternalLinks.Select(i => i.Key).ToArray();
25+
var crossLinks = set.Context.Collector.CrossLinks.Select(i => i.Key).ToArray();
2626

2727
var links = set.FlatMappedFiles.Values
2828
.OfType<MarkdownFile>()
@@ -32,7 +32,7 @@ public static LinkReference Create(DocumentationSet set)
3232
UrlPathPrefix = set.Context.UrlPathPrefix,
3333
Origin = set.Context.Git,
3434
Links = links,
35-
ExternalLinks = externalLinks
35+
CrossLinks = crossLinks
3636
};
3737
}
3838
}

tests/Elastic.Markdown.Tests/Inline/InlineLinkTests.cs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ public void GeneratesHtml() =>
103103
public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
104104
}
105105

106-
public class ExternalLinkReferenceTest(ITestOutputHelper output) : LinkTestBase(output,
106+
public class CrossLinkReferenceTest(ITestOutputHelper output) : LinkTestBase(output,
107107
"""
108108
[test][test]
109109
@@ -123,14 +123,14 @@ public void GeneratesHtml() =>
123123
public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
124124

125125
[Fact]
126-
public void EmitsExternalLink()
126+
public void EmitsCrossLink()
127127
{
128-
Collector.ExternalLinks.Should().HaveCount(1);
129-
Collector.ExternalLinks.Should().ContainKey("kibana://index.md");
128+
Collector.CrossLinks.Should().HaveCount(1);
129+
Collector.CrossLinks.Should().ContainKey("kibana://index.md");
130130
}
131131
}
132132

133-
public class ExternalLinkTest(ITestOutputHelper output) : LinkTestBase(output,
133+
public class CrossLinkTest(ITestOutputHelper output) : LinkTestBase(output,
134134
"""
135135
[test](kibana://index.md)
136136
"""
@@ -148,14 +148,14 @@ public void GeneratesHtml() =>
148148
public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
149149

150150
[Fact]
151-
public void EmitsExternalLink()
151+
public void EmitsCrossLink()
152152
{
153-
Collector.ExternalLinks.Should().HaveCount(1);
154-
Collector.ExternalLinks.Should().ContainKey("kibana://index.md");
153+
Collector.CrossLinks.Should().HaveCount(1);
154+
Collector.CrossLinks.Should().ContainKey("kibana://index.md");
155155
}
156156
}
157157

158-
public class DuplicateExternalLinkTest(ITestOutputHelper output) : LinkTestBase(output,
158+
public class DuplicateCrossLinkTest(ITestOutputHelper output) : LinkTestBase(output,
159159
"""
160160
[a](kibana://index.md)
161161
[b](kibana://index.md)
@@ -179,11 +179,11 @@ public void GeneratesHtml() =>
179179
public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
180180

181181
[Fact]
182-
public void EmitsExternalLink()
182+
public void EmitsCrossLink()
183183
{
184-
Collector.ExternalLinks.Should().HaveCount(2);
185-
Collector.ExternalLinks.Should().ContainKey("kibana://index.md");
186-
Collector.ExternalLinks.Should().ContainKey("elasticsearch://index.md");
184+
Collector.CrossLinks.Should().HaveCount(2);
185+
Collector.CrossLinks.Should().ContainKey("kibana://index.md");
186+
Collector.CrossLinks.Should().ContainKey("elasticsearch://index.md");
187187
}
188188
}
189189

0 commit comments

Comments
 (0)