Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CI] Enable documentation check #429

Open
shahmishal opened this issue Oct 25, 2024 · 0 comments
Open

[CI] Enable documentation check #429

shahmishal opened this issue Oct 25, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@shahmishal
Copy link
Member

https://github.com/apple/swift-collections/actions/runs/11512888219/job/32048639180?pr=426

[405/405] Compiling Collections Collections.swift
Build of target: 'Collections' complete! (15.26s)
Generating documentation for 'Collections'...
Converting documentation...
warning: '--level' is deprecated. Use '--coverage-summary-level' instead.
warning: '--index' is deprecated. Use '--emit-lmdb-index' indead.
error: 'BitSet' doesn't exist at '/Collections'
  --> Collections.md:19:5-19:11
17 | ### Bit Collections
18 |
19 + - ``BitSet``
20 | - ``BitArray``
21 |

error: 'BitArray' doesn't exist at '/Collections'
  --> Collections.md:20:5-20:13
18 |
19 | - ``BitSet``
20 + - ``BitArray``
21 |
22 | ### Deque Module

error: 'Deque' doesn't exist at '/Collections'
  --> Collections.md:24:5-24:10
22 | ### Deque Module
23 |
24 + - ``Deque``
   |     ╰─suggestion: Replace 'Deque' with 'Deque-Module'
25 |
26 | ### Heap Module

error: 'Heap' doesn't exist at '/Collections'
  --> Collections.md:28:5-28:9
26 | ### Heap Module
27 |
28 + - ``Heap``
   |     ╰─suggestion: Replace 'Heap' with 'Heap-Module'
29 |
30 | ### Ordered Collections

error: 'OrderedSet' doesn't exist at '/Collections'
  --> Collections.md:32:5-32:15
30 | ### Ordered Collections
31 |
32 + - ``OrderedSet``
   |     ╰─suggestion: Replace 'OrderedSet' with 'Ordered-Collections'
33 | - ``OrderedDictionary``
34 |

error: 'OrderedDictionary' doesn't exist at '/Collections'
  --> Collections.md:33:5-33:22
31 |
32 | - ``OrderedSet``
33 + - ``OrderedDictionary``
   |     ╰─suggestion: Replace 'OrderedDictionary' with 'Ordered-Collections'
34 |
35 | ### Persistent Hashed Collections

error: 'TreeSet' doesn't exist at '/Collections'
  --> Collections.md:37:5-37:12
35 | ### Persistent Hashed Collections
36 |
37 + - ``TreeSet``
38 | - ``TreeDictionary``

error: 'TreeDictionary' doesn't exist at '/Collections'
  --> Collections.md:38:5-38:19
36 |
37 | - ``TreeSet``
38 + - ``TreeDictionary``

note: This document does not have a summary.
An abstract provides a short description of the document. Write a paragraph below the title of the document to use it as an abstract.
 --> Extensions/BitArray.md:1:1-1:27
1 + # ``Collections/BitArray``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

error: No symbol matched 'Collections/BitArray'. 'BitArray' doesn't exist at '/Collections'.
 --> Extensions/BitArray.md:1:3-1:27
1 + # ``Collections/BitArray``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

note: This document does not have a summary.
An abstract provides a short description of the document. Write a paragraph below the title of the document to use it as an abstract.
 --> Extensions/BitSet.Counted.md:1:1-1:46
1 + # ``Collections/BitSet/Counted-swift.struct``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

error: No symbol matched 'Collections/BitSet/Counted-swift.struct'. 'BitSet' doesn't exist at '/Collections'.
 --> Extensions/BitSet.Counted.md:1:3-1:46
1 + # ``Collections/BitSet/Counted-swift.struct``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

note: This document does not have a summary.
An abstract provides a short description of the document. Write a paragraph below the title of the document to use it as an abstract.
 --> Extensions/BitSet.md:1:1-1:25
1 + # ``Collections/BitSet``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

error: No symbol matched 'Collections/BitSet'. 'BitSet' doesn't exist at '/Collections'.
 --> Extensions/BitSet.md:1:3-1:25
1 + # ``Collections/BitSet``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

note: This document does not have a summary.
An abstract provides a short description of the document. Write a paragraph below the title of the document to use it as an abstract.
 --> Extensions/Deque.md:1:1-1:24
1 + # ``Collections/Deque``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

error: No symbol matched 'Collections/Deque'. 'Deque' doesn't exist at '/Collections'.
 --> Extensions/Deque.md:1:3-1:24
1 + # ``Collections/Deque``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

note: This document does not have a summary.
An abstract provides a short description of the document. Write a paragraph below the title of the document to use it as an abstract.
 --> Extensions/Heap.md:1:1-1:23
1 + # ``Collections/Heap``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

error: No symbol matched 'Collections/Heap'. 'Heap' doesn't exist at '/Collections'.
 --> Extensions/Heap.md:1:3-1:23
1 + # ``Collections/Heap``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

note: This document does not have a summary.
An abstract provides a short description of the document. Write a paragraph below the title of the document to use it as an abstract.
 --> Extensions/OrderedDictionary.Elements.md:1:1-1:58
1 + # ``Collections/OrderedDictionary/Elements-swift.struct``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

error: No symbol matched 'Collections/OrderedDictionary/Elements-swift.struct'. 'OrderedDictionary' doesn't exist at '/Collections'.
 --> Extensions/OrderedDictionary.Elements.md:1:3-1:58
1 + # ``Collections/OrderedDictionary/Elements-swift.struct``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

note: This document does not have a summary.
An abstract provides a short description of the document. Write a paragraph below the title of the document to use it as an abstract.
 --> Extensions/OrderedDictionary.Values.md:1:1-1:56
1 + # ``Collections/OrderedDictionary/Values-swift.struct``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

error: No symbol matched 'Collections/OrderedDictionary/Values-swift.struct'. 'OrderedDictionary' doesn't exist at '/Collections'.
 --> Extensions/OrderedDictionary.Values.md:1:3-1:56
1 + # ``Collections/OrderedDictionary/Values-swift.struct``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

note: This document does not have a summary.
An abstract provides a short description of the document. Write a paragraph below the title of the document to use it as an abstract.
 --> Extensions/OrderedDictionary.md:1:1-1:36
1 + # ``Collections/OrderedDictionary``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

error: No symbol matched 'Collections/OrderedDictionary'. 'OrderedDictionary' doesn't exist at '/Collections'.
 --> Extensions/OrderedDictionary.md:1:3-1:36
1 + # ``Collections/OrderedDictionary``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

note: This document does not have a summary.
An abstract provides a short description of the document. Write a paragraph below the title of the document to use it as an abstract.
 --> Extensions/OrderedSet.UnorderedView.md:1:1-1:43
1 + # ``Collections/OrderedSet/UnorderedView``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

error: No symbol matched 'Collections/OrderedSet/UnorderedView'. 'OrderedSet' doesn't exist at '/Collections'.
 --> Extensions/OrderedSet.UnorderedView.md:1:3-1:43
1 + # ``Collections/OrderedSet/UnorderedView``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

note: This document does not have a summary.
An abstract provides a short description of the document. Write a paragraph below the title of the document to use it as an abstract.
 --> Extensions/OrderedSet.md:1:1-1:29
1 + # ``Collections/OrderedSet``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

error: No symbol matched 'Collections/OrderedSet'. 'OrderedSet' doesn't exist at '/Collections'.
 --> Extensions/OrderedSet.md:1:3-1:29
1 + # ``Collections/OrderedSet``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

note: This document does not have a summary.
An abstract provides a short description of the document. Write a paragraph below the title of the document to use it as an abstract.
 --> Extensions/TreeDictionary.md:1:1-1:33
1 + # ``Collections/TreeDictionary``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

error: No symbol matched 'Collections/TreeDictionary'. 'TreeDictionary' doesn't exist at '/Collections'.
 --> Extensions/TreeDictionary.md:1:3-1:33
error: 'docc convert' invocation failed with a nonzero exit code: '1'
1 + # ``Collections/TreeDictionary``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

note: This document does not have a summary.
An abstract provides a short description of the document. Write a paragraph below the title of the document to use it as an abstract.
 --> Extensions/TreeSet.md:1:1-1:26
1 + # ``Collections/TreeSet``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->

error: No symbol matched 'Collections/TreeSet'. 'TreeSet' doesn't exist at '/Collections'.
 --> Extensions/TreeSet.md:1:3-1:26
1 + # ``Collections/TreeSet``
2 |
3 | <!-- DO NOT EDIT THIS FILE; IT'S AUTOMATICALLY GENERATED -->Error: An error was encountered while compiling documentation
Error: Process completed with exit code 1.
@shahmishal shahmishal added the bug Something isn't working label Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant