-
Notifications
You must be signed in to change notification settings - Fork 128
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
Fix typo assesment -> assessment #445
Conversation
@swift-ci please test |
@@ -1936,7 +1936,7 @@ | |||
}, | |||
"sections": { | |||
"type": "string", | |||
"enum": ["task", "assesment", "heading"] | |||
"enum": ["task", "assessment", "heading"] | |||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this a breaking change for swift-docc-render? @ethan-kusters
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It shouldn't be – I believe this is just fixing the incorrect spec. We should confirm the emitted JSON has always had the correct spelling (assessment
) before merging but I believe it has.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The is confirmed on swift-docc-render and swift-docc. But I think we still need a test case for it though.
@swift-ci please test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would you mind writing a test case for it before merging?
I see. Thank you. What kind of tests do I need to add? Sorry, it's s my first time contribution and not sure what to do actually. |
It corresponds to the code in After searching in project, it turns out that we currently do not have any sort of test case for openapi json file. Maybe we can add such later when swift-openapi-generator is mature. |
@swift-ci please test |
Bug/issue #, if applicable:
Summary
I found typos in some places, so fixed them. please correct me if I am wrong.
Dependencies
None
Testing
Please check the spelling
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
Added tests./bin/test
script and it succeededUpdated documentation if necessary