search

swiftlang / swift-markdown

A Swift package for parsing, building, editing, and analyzing Markdown documents.
https://swiftpackageindex.com/swiftlang/swift-markdown/documentation/markdown
Apache License 2.0
2.79k stars 191 forks source link

parameter updates in documentation #206

Closed heckj closed 2 weeks ago

heckj commented 3 weeks ago

While using this package as test subject while debugging another issue, I noticed a few warnings about misnamed or missing parameters (thank you latest DocC diagnostics!). This updates those to resolve the doc warnings (and correct the documentation)

Kyle-Ye commented 2 weeks ago

@swift-ci test

Kyle-Ye commented 2 weeks ago

I see there are still other warnings. But this looks good to me so far.

warning: 'Snippets' is ambiguous at '/Markdown'
  --> Markdown.md:17:8-17:16
15 | A quick overview of examples showing tasks you can achieve with Swift Markdown.
16 |
17 + - <doc:Snippets>
   |                ├─suggestion: Insert 'anchor' for'Snippets'
   |                ╰─suggestion: Insert 'article' for'Snippets'
18 |
19 | ### Getting Started

warning: 'Infrastructure' is ambiguous at '/Markdown'
  --> Markdown.md:44:8-44:22
42 | ### Infrastructure
43 |
44 + - <doc:Infrastructure>
   |                      ├─suggestion: Insert 'anchor' for'Infrastructure'
   |                      ╰─suggestion: Insert 'article' for'Infrastructure'
45 |
46 | ### Visit MarkupFinished building documentation for 'Markdown' (1.19s)