Enable parameter and return value validation by default #882
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
patshaughnessy
approved these changes
Apr 5, 2024
| /// Begins the given metric. | ||
| /// - Parameters: | ||
| /// - metric: The metric to begin measuring. | ||
| /// - log: The log that may filter out the metric. |
There was a problem hiding this comment.
Should we add a Returns: doc comment for this function also?
There was a problem hiding this comment.
The goal of this PR isn't to extensively document all the parameters and return values, only to fix the warnings about mis-documented parameters or return values.
| @@ -104,7 +104,6 @@ public struct CoverageDataEntry: CustomStringConvertible, Codable { | |||
| } | |||
|
|
|||
| /// Outputs a short table summarizing the coverage statistics for a list of data entries. | |||
| /// - Parameter coverageInfo: An array of entries to summarize. | |||
There was a problem hiding this comment.
Because it's an experimental API that result in warnings about not having all of its parameters documented.
Comment on lines
-26
to
-27
| - ``defaultCodeListingLanguage`` | ||
| - ``defaultAvailability`` |
There was a problem hiding this comment.
Why removing these symbols from here? There are also part of the Documentation Bundle.
There was a problem hiding this comment.
They are not. These links don't resolve to anything.
Sources/docc/DocCDocumentation.docc/documenting-api-with-different-language-representations.md
Show resolved
Hide resolved
Sources/docc/DocCDocumentation.docc/documenting-api-with-different-language-representations.md
Outdated
Show resolved
Hide resolved
rdar://125835874
|
@swift-ci please test |
|
@swift-ci please test |
d-ronnqvist
added a commit
to d-ronnqvist/swift-docc
that referenced
this pull request
Apr 24, 2024
* Enable parameter and return value validation by default rdar://125835874 * Remove various links to symbols that no longer exist * Fix warnings about undocumented parameters * Add article about documenting multi-source-language APIs * Fix additional warnings about undocumented parameters * Refine the synthesized content phrasing for ObjC API with errors rdar://125835874 * Clarify documentation about documenting return values. * Update example error documentation * Rename feature flag to remove "experimental" * Remove redundant test setup * Fix test that documented parameters that the symbol didn't have * Fix test that was expecting the wrong number of diagnostics * Add license comment to new documentation article
d-ronnqvist
added a commit
that referenced
this pull request
Apr 25, 2024
emilyychenn
pushed a commit
to emilyychenn/swift-docc
that referenced
this pull request
Apr 30, 2024
* Enable parameter and return value validation by default rdar://125835874 * Remove various links to symbols that no longer exist * Fix warnings about undocumented parameters * Add article about documenting multi-source-language APIs * Fix additional warnings about undocumented parameters * Refine the synthesized content phrasing for ObjC API with errors rdar://125835874 * Clarify documentation about documenting return values. * Update example error documentation * Rename feature flag to remove "experimental" * Remove redundant test setup * Fix test that documented parameters that the symbol didn't have * Fix test that was expecting the wrong number of diagnostics * Add license comment to new documentation article
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bug/issue #, if applicable: rdar://125835874
Summary
This enables DocC's processing and validation of parameter and return value documentation by default.
It also uses this flag to fix the new warnings in DocC about incorrectly documented parameters or return values.
Lastly, it adds an article that describe the basics of documenting multi-source-language API and describe the new parameter and return value behaviors.
Dependencies
None.
Testing
The steps described in #776 now apply by default.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded