Skip to content
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

Merged
merged 3 commits into from Jul 7, 2023
Merged

Fix typo assesment -> assessment #445

merged 3 commits into from Jul 7, 2023

Conversation

stzn
Copy link
Contributor

@stzn stzn commented Dec 31, 2022

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
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

@ethan-kusters
Copy link
Contributor

@swift-ci please test

@ethan-kusters ethan-kusters self-requested a review January 3, 2023 18:31
@@ -1936,7 +1936,7 @@
},
"sections": {
"type": "string",
"enum": ["task", "assesment", "heading"]
"enum": ["task", "assessment", "heading"]
}
Copy link
Collaborator

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

Copy link
Contributor

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.

Copy link
Collaborator

@Kyle-Ye Kyle-Ye Jul 7, 2023

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.

@Kyle-Ye
Copy link
Collaborator

Kyle-Ye commented Jul 6, 2023

@swift-ci please test

Copy link
Collaborator

@Kyle-Ye Kyle-Ye left a 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?

@stzn
Copy link
Contributor Author

stzn commented Jul 7, 2023

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.

@Kyle-Ye
Copy link
Collaborator

Kyle-Ye commented Jul 7, 2023

It corresponds to the code in RenderHierarchyLandmark.swift.

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.

@Kyle-Ye
Copy link
Collaborator

Kyle-Ye commented Jul 7, 2023

@swift-ci please test

@Kyle-Ye Kyle-Ye merged commit d3239b1 into apple:main Jul 7, 2023
2 checks passed
@stzn stzn deleted the fix-typo branch July 7, 2023 18:54
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.

None yet

3 participants