Support documenting http responses, property list values, parameters, etc. with spaces in the name #1017
Conversation
This file contains 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
… etc. with spaces in the name rdar://134705941
|
@swift-ci please test |
anferbui
reviewed
Sep 2, 2024
|
|
||
| for whitespace in [" ", " ", "\t"] { | ||
| let parameters = extractedTags(""" | ||
| - Parameter\(whitespace)some parameter with spaces: Some description of this parameter. |
There was a problem hiding this comment.
Nit: It looks like we're missing some tests for when there's nothing after the list item tag (e.g. just - Parameter: Some description of this parameter., would it be worth adding some?
There was a problem hiding this comment.
I have tests like that on lines 70-74:
XCTAssert(extractedTags("- Parameter: Missing parameter name.").parameters.isEmpty)
XCTAssert(extractedTags("- Parameter : Missing parameter name.").parameters.isEmpty)
XCTAssert(extractedTags("- DictionaryKey: Missing key name.").parameters.isEmpty)
XCTAssert(extractedTags("- PossibleValue: Missing value name.").parameters.isEmpty)There was a problem hiding this comment.
Although now, that I read those tests I see that I'm verifying the wrong lists for the last two tests.
There was a problem hiding this comment.
Although now, that I read those tests I see that I'm verifying the wrong lists for the last two tests.
Fixed in 093ed59
XCTAssert(extractedTags("- Parameter: Missing parameter name.").parameters.isEmpty)
XCTAssert(extractedTags("- Parameter : Missing parameter name.").parameters.isEmpty)
XCTAssert(extractedTags("- DictionaryKey: Missing key name.").dictionaryKeys.isEmpty)
XCTAssert(extractedTags("- PossibleValue: Missing value name.").possiblePropertyListValues.isEmpty)
anferbui
approved these changes
Sep 2, 2024
|
@swift-ci please test |
anferbui
approved these changes
Sep 2, 2024
|
@swift-ci please test |
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://134705941
Summary
This updates the parsing for "tagged" list (http responses, property list values, parameters, etc.) to support documenting responses/values/keys/parameters with spaces in the name.
For example:
- DictionaryKey some key with spaces: Some description of this dictionary key.now parses the entire "some key with spaces" as the name of the dictionary key that the documentation applies to.
Dependencies
None.
Testing
The hardest part of testing this is using a symbol graph file with list elements with spaces in the names. There is one such example among the test bundles.
Add a new documentation extension file to
Tests/Swith the following content:Run
swift run docc preview /Tests/SwiftDocCTests/Test\ Bundles/DictionaryData.doccand navigate to the "Genre" page.Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded[ ] Updated documentation if necessary