[6.0] Enable parameter and return value validation by default (#882) #897
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
Contributor
d-ronnqvist
commented
Apr 24, 2024
d-ronnqvist
commented
- Explanation: This enabled DocC's new parameter and return value validation by default and fixes the warnings in the DocC code that are raised by this feature.
- Scope: Diagnostics for incorrect parameter and return value documentation. Better handling of parameters and return values that only exist in one language representation of a symbol.
- Issue: rdar://125835874
- Risk: Low.
- Testing: Existing automated tests pass. Manually used the feature on DocC's code to find a large number of mis-documented parameters.
- Reviewer: @patshaughnessy
- Original PR: Enable parameter and return value validation by default #882
* 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
|
@swift-ci please test |
franklinsch
approved these changes
Apr 25, 2024
QuietMisdreavus
added a commit
to QuietMisdreavus/swift-docc
that referenced
this pull request
May 31, 2024
this fixes an issue when tests are run sequentially; testParameterValidationFeatureFlag (added in swiftlang#897) can fail if run after testOptionsValidation, because it sets `DOCC_HTML_DIR` to a temporary directory, which is deleted after the test exits. by resetting the environment variable in a defer block, we can restore a proper environment for later tests.
QuietMisdreavus
added a commit
to QuietMisdreavus/swift-docc
that referenced
this pull request
May 31, 2024
this fixes an issue when tests are run sequentially; testParameterValidationFeatureFlag (added in swiftlang#897) can fail if run after testOptionsValidation, because it sets `DOCC_HTML_DIR` to a temporary directory, which is deleted after the test exits. by resetting the environment variable in a defer block, we can restore a proper environment for later tests.
QuietMisdreavus
added a commit
that referenced
this pull request
Jun 4, 2024
* unset template environment after testOptionsValidation exits this fixes an issue when tests are run sequentially; testParameterValidationFeatureFlag (added in #897) can fail if run after testOptionsValidation, because it sets `DOCC_HTML_DIR` to a temporary directory, which is deleted after the test exits. by resetting the environment variable in a defer block, we can restore a proper environment for later tests. * reset the environment for all ConvertSubcommandTests * set pwd to a temporary directory this ensures that the tests aren't affected by the machine environment, for example if a gitignore'd path contains a symlink
QuietMisdreavus
added a commit
to QuietMisdreavus/swift-docc
that referenced
this pull request
Jul 16, 2024
* unset template environment after testOptionsValidation exits this fixes an issue when tests are run sequentially; testParameterValidationFeatureFlag (added in swiftlang#897) can fail if run after testOptionsValidation, because it sets `DOCC_HTML_DIR` to a temporary directory, which is deleted after the test exits. by resetting the environment variable in a defer block, we can restore a proper environment for later tests. * reset the environment for all ConvertSubcommandTests * set pwd to a temporary directory this ensures that the tests aren't affected by the machine environment, for example if a gitignore'd path contains a symlink
QuietMisdreavus
added a commit
that referenced
this pull request
Jul 16, 2024
* unset template environment after testOptionsValidation exits this fixes an issue when tests are run sequentially; testParameterValidationFeatureFlag (added in #897) can fail if run after testOptionsValidation, because it sets `DOCC_HTML_DIR` to a temporary directory, which is deleted after the test exits. by resetting the environment variable in a defer block, we can restore a proper environment for later tests. * reset the environment for all ConvertSubcommandTests * set pwd to a temporary directory this ensures that the tests aren't affected by the machine environment, for example if a gitignore'd path contains a symlink
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.