Skip to content

Fix warnings when generating documentation using docc #1777

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

Merged
merged 1 commit into from
Jun 14, 2023

Conversation

ahoppen
Copy link
Member

@ahoppen ahoppen commented Jun 13, 2023

No description provided.

@ahoppen ahoppen requested a review from bnbarham June 13, 2023 22:28
@ahoppen ahoppen marked this pull request as ready for review June 13, 2023 22:28
@ahoppen
Copy link
Member Author

ahoppen commented Jun 13, 2023

@swift-ci Please test

/// Unlike ``TokenConsumer/eat(_:)``, ``Parser/expect(_:remapping:)`` returns
/// Unlike `TokenConsumer.eat(_:)`, `Parser.expect(_:remapping:)` returns
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there no way to link to these (and all the others that had similar treatment)?

Copy link
Member Author

Choose a reason for hiding this comment

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

No, because TokenConsumer.eat is not public, it doesn’t show up in the generated documentation and hence there’s no way to link to it.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah I see 👍

@ahoppen ahoppen merged commit 338a626 into swiftlang:main Jun 14, 2023
@ahoppen ahoppen deleted the ahoppen/docc-warnings branch June 14, 2023 16:22
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