Skip to content

Conversation

@heckj
Copy link
Member

@heckj heckj commented Nov 7, 2024

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)

  • resolved warnings generated by latest DocC compilation that
    highlighted missing, renamed, or misnamed parameters within
    the documentation.

- resolved warnings generated by latest DocC compilation that
  highlighted missing, renamed, or misnamed parameters within
  the documentation.
@Kyle-Ye
Copy link
Contributor

Kyle-Ye commented Nov 16, 2024

@swift-ci test

Copy link
Contributor

@Kyle-Ye Kyle-Ye left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Kyle-Ye
Copy link
Contributor

Kyle-Ye commented Nov 17, 2024

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)

@Kyle-Ye Kyle-Ye merged commit 82f9258 into swiftlang:main Nov 17, 2024
2 checks passed
@heckj heckj deleted the doc-fixes branch November 17, 2024 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants