Skip to content

Conversation

@binamaniar
Copy link
Contributor

@binamaniar binamaniar commented Jun 16, 2022

Bug/issue #, if applicable:
rdar://78015631

Summary

Diagnostic message that mentions the term 'abstract' is actually referring to 'summary'. The change unifies the terminology in the diagnostic message to use 'summary'.

Dependencies

No known dependencies

Testing

  1. Create a project in Xcode, it can be a swift project
  2. Create .docc folder in that, and a .md file
  3. Have an image or a link in a title
  4. Build documentation.
  5. Diagnostic to be added for the above and diagnostic message should include the term summary and not abstract.

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

@binamaniar
Copy link
Contributor Author

@swift-ci please test

@binamaniar binamaniar requested a review from franklinsch June 17, 2022 20:03
Copy link
Contributor

@franklinsch franklinsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @binamaniar!

@binamaniar
Copy link
Contributor Author

@swift-ci please test

@binamaniar binamaniar merged commit eb8e694 into swiftlang:main Jun 23, 2022
binamaniar added a commit to binamaniar/swift-docc that referenced this pull request Jun 23, 2022
…lang#310)

fix for replacing the term abstract with summary in diagnostic rdar://78015631
binamaniar added a commit that referenced this pull request Jun 23, 2022
…#320)

fix for replacing the term abstract with summary in diagnostic rdar://78015631
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.

2 participants