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

[SR-15434] Add support for custom (non-framework) module kinds #33

Merged
merged 2 commits into from
Nov 12, 2021

Conversation

ethan-kusters
Copy link
Contributor

@ethan-kusters ethan-kusters commented Nov 9, 2021

Bug/issue #, if applicable: SR-15434 and rdar://83448323

Summary

Adds support for providing custom module kinds to Swift-DocC via a DocC Catalog's Info.plist or the command-line.

There is a detailed pitch for this feature on the Swift Forums.

This also updates Swift-DocC's user-facing documentation to be accurately described as a "Tool" instead of a "Framework".

Before After
Screen Shot 2021-11-03 at 3 06 08 PM Screen Shot 2021-11-03 at 4 58 17 PM

Dependencies

None.

Testing

Build documentation for DocC's user-facing documentation and confirm that the eyebrow-text on the top-level page contains "Tool" and not "Framework".

Steps:

  1. bin/preview-docs DocC

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 ethan-kusters self-assigned this Nov 9, 2021
@ethan-kusters ethan-kusters changed the title [SR-15434] Add support for custom (non-Framework) module kinds [SR-15434] Add support for custom (non-framework) module kinds Nov 9, 2021
@ethan-kusters
Copy link
Contributor Author

@swift-ci please test

@ethan-kusters
Copy link
Contributor Author

@swift-ci please test

@ethan-kusters
Copy link
Contributor Author

@swift-ci please test

Resolves rdar://83448323 and SR-15434.
In this context, DocC is a "Tool" not a "Framework".
@ethan-kusters
Copy link
Contributor Author

@swift-ci please test

@ethan-kusters ethan-kusters merged commit 0752acf into apple:main Nov 12, 2021
@ethan-kusters ethan-kusters deleted the SR-15434-custom-module-kinds branch November 12, 2021 23:36
ethan-kusters added a commit to ethan-kusters/swift-docc that referenced this pull request May 21, 2022
Updates swift-markdown to include:

    commit 7a7c59d1160fddd23e2379ec5ee8c71df7fd0b3b
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Fri May 20 18:53:24 2022 -0700

	    Improve performance of `Markup.child(at:)` method (apple#44)

	    Improves the performance of `Markup.child(at:)` by refactoring to removing
	    the need to iterate over all previous elements in the child array.

    commit 36cf89e36e94b025dbe37d82fe2a7da3f39d4204
    Author: Franklin Schrans <fschrans@apple.com>
    Date:   Wed Mar 23 14:38:18 2022 +0100

	    Remove extraneous print in test (apple#33)

    commit e50693584310a9190071c96c839485b6f2376832
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Mon Mar 21 10:42:02 2022 -0700

	    Publish Swift Markdown's documentation to GitHub pages (apple#32)

	    * Adopt the Swift-DocC Plugin for documentation generation

	    * Add a script for publishing docs to GitHub pages

	    * Add missing license headers

	    * Move README docs to articles in the DocC catalog

	    * Remove out-of-date documentation about `DiagnosticEngine`

	    Swift markdown no longer includes a DiagnosticEngine so these links were failing
	    to resolve.

    commit 5f10cfb030f43222a49ea34857ff07f02f1e38b0
    Author: christopherweems <github@christopherweems.com>
    Date:   Sat Mar 19 12:53:31 2022 -0400

	    Fix typo in documentation for `MarkupVisitor` (apple#26)

	    Co-authored-by: Christopher Weems <hello@christopherweems.com>
ethan-kusters added a commit to ethan-kusters/swift-docc that referenced this pull request May 21, 2022
Updates swift-markdown to include:

    commit 7a7c59d1160fddd23e2379ec5ee8c71df7fd0b3b
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Fri May 20 18:53:24 2022 -0700

	    Improve performance of `Markup.child(at:)` method (apple#44)

	    Improves the performance of `Markup.child(at:)` by refactoring to removing
	    the need to iterate over all previous elements in the child array.

    commit 36cf89e36e94b025dbe37d82fe2a7da3f39d4204
    Author: Franklin Schrans <fschrans@apple.com>
    Date:   Wed Mar 23 14:38:18 2022 +0100

	    Remove extraneous print in test (apple#33)

    commit e50693584310a9190071c96c839485b6f2376832
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Mon Mar 21 10:42:02 2022 -0700

	    Publish Swift Markdown's documentation to GitHub pages (apple#32)

	    * Adopt the Swift-DocC Plugin for documentation generation

	    * Add a script for publishing docs to GitHub pages

	    * Add missing license headers

	    * Move README docs to articles in the DocC catalog

	    * Remove out-of-date documentation about `DiagnosticEngine`

	    Swift markdown no longer includes a DiagnosticEngine so these links were failing
	    to resolve.

    commit 5f10cfb030f43222a49ea34857ff07f02f1e38b0
    Author: christopherweems <github@christopherweems.com>
    Date:   Sat Mar 19 12:53:31 2022 -0400

	    Fix typo in documentation for `MarkupVisitor` (apple#26)

	    Co-authored-by: Christopher Weems <hello@christopherweems.com>
ethan-kusters added a commit to ethan-kusters/swift-docc that referenced this pull request May 21, 2022
Updates swift-markdown to include:

    commit 7a7c59d1160fddd23e2379ec5ee8c71df7fd0b3b
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Fri May 20 18:53:24 2022 -0700

	    Improve performance of `Markup.child(at:)` method (apple#44)

	    Improves the performance of `Markup.child(at:)` by refactoring to removing
	    the need to iterate over all previous elements in the child array.

    commit 36cf89e36e94b025dbe37d82fe2a7da3f39d4204
    Author: Franklin Schrans <fschrans@apple.com>
    Date:   Wed Mar 23 14:38:18 2022 +0100

	    Remove extraneous print in test (apple#33)

    commit e50693584310a9190071c96c839485b6f2376832
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Mon Mar 21 10:42:02 2022 -0700

	    Publish Swift Markdown's documentation to GitHub pages (apple#32)

	    * Adopt the Swift-DocC Plugin for documentation generation

	    * Add a script for publishing docs to GitHub pages

	    * Add missing license headers

	    * Move README docs to articles in the DocC catalog

	    * Remove out-of-date documentation about `DiagnosticEngine`

	    Swift markdown no longer includes a DiagnosticEngine so these links were failing
	    to resolve.

    commit 5f10cfb030f43222a49ea34857ff07f02f1e38b0
    Author: christopherweems <github@christopherweems.com>
    Date:   Sat Mar 19 12:53:31 2022 -0400

	    Fix typo in documentation for `MarkupVisitor` (apple#26)

	    Co-authored-by: Christopher Weems <hello@christopherweems.com>
ethan-kusters added a commit to ethan-kusters/swift-docc that referenced this pull request May 21, 2022
Updates swift-markdown to include:

    commit 5fc007220571bf194930a98edeab7133156ab01c
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Sat May 21 12:20:47 2022 -0700

	    Correctly set `indexInParent` in `Markup.child(at:)`

	    This fixes a recent regression where `Markup.child(at:)` began returning
	    markup with incorrect metadata resulting in out-of-bounds errors.

	    The `indexInParent` value of a child is unrelated to the parent's
	    `indexInParent`. This was missed initially because tests were only
	    checking for children of the first item where `indexInParent` would
	    be 0. A new test has been added that asserts `Markup.child(at:)` returns
	    correct values for children of nested items as well.

    commit 7a7c59d1160fddd23e2379ec5ee8c71df7fd0b3b
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Fri May 20 18:53:24 2022 -0700

	    Improve performance of `Markup.child(at:)` method (apple#44)

	    Improves the performance of `Markup.child(at:)` by refactoring to removing
	    the need to iterate over all previous elements in the child array.

    commit 36cf89e36e94b025dbe37d82fe2a7da3f39d4204
    Author: Franklin Schrans <fschrans@apple.com>
    Date:   Wed Mar 23 14:38:18 2022 +0100

	    Remove extraneous print in test (apple#33)

    commit e50693584310a9190071c96c839485b6f2376832
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Mon Mar 21 10:42:02 2022 -0700

	    Publish Swift Markdown's documentation to GitHub pages (apple#32)

	    * Adopt the Swift-DocC Plugin for documentation generation

	    * Add a script for publishing docs to GitHub pages

	    * Add missing license headers

	    * Move README docs to articles in the DocC catalog

	    * Remove out-of-date documentation about `DiagnosticEngine`

	    Swift markdown no longer includes a DiagnosticEngine so these links were failing
	    to resolve.

    commit 5f10cfb030f43222a49ea34857ff07f02f1e38b0
    Author: christopherweems <github@christopherweems.com>
    Date:   Sat Mar 19 12:53:31 2022 -0400

	    Fix typo in documentation for `MarkupVisitor` (apple#26)

	    Co-authored-by: Christopher Weems <hello@christopherweems.com>
ethan-kusters added a commit to ethan-kusters/swift-docc that referenced this pull request May 21, 2022
Updates swift-markdown to include:

    commit 97df6e2812adcf8698204ca5f0756563ef36e5c1
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Sat May 21 14:02:22 2022 -0700

        Correctly set `indexInParent` in `Markup.child(at:)` (apple#45)

        This fixes a recent regression where `Markup.child(at:)` began returning
        markup with incorrect metadata resulting in out-of-bounds errors.

        The `indexInParent` value of a child is unrelated to the parent's
        `indexInParent`. This was missed initially because tests were only
        checking for children of the first item where `indexInParent` would
        be 0. A new test has been added that asserts `Markup.child(at:)` returns
        correct values for children of nested items as well.

    commit 7a7c59d1160fddd23e2379ec5ee8c71df7fd0b3b
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Fri May 20 18:53:24 2022 -0700

        Improve performance of `Markup.child(at:)` method (apple#44)

        Improves the performance of `Markup.child(at:)` by refactoring to removing
        the need to iterate over all previous elements in the child array.

    commit 36cf89e36e94b025dbe37d82fe2a7da3f39d4204
    Author: Franklin Schrans <fschrans@apple.com>
    Date:   Wed Mar 23 14:38:18 2022 +0100

        Remove extraneous print in test (apple#33)

    commit e50693584310a9190071c96c839485b6f2376832
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Mon Mar 21 10:42:02 2022 -0700

        Publish Swift Markdown's documentation to GitHub pages (apple#32)

        * Adopt the Swift-DocC Plugin for documentation generation

        * Add a script for publishing docs to GitHub pages

        * Add missing license headers

        * Move README docs to articles in the DocC catalog

        * Remove out-of-date documentation about `DiagnosticEngine`

        Swift markdown no longer includes a DiagnosticEngine so these links were failing
        to resolve.

    commit 5f10cfb030f43222a49ea34857ff07f02f1e38b0
    Author: christopherweems <github@christopherweems.com>
    Date:   Sat Mar 19 12:53:31 2022 -0400

        Fix typo in documentation for `MarkupVisitor` (apple#26)

        Co-authored-by: Christopher Weems <hello@christopherweems.com>
ethan-kusters added a commit to ethan-kusters/swift-docc that referenced this pull request May 21, 2022
Updates swift-markdown to include:

    commit 97df6e2812adcf8698204ca5f0756563ef36e5c1
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Sat May 21 14:02:22 2022 -0700

        Correctly set `indexInParent` in `Markup.child(at:)` (apple#45)

        This fixes a recent regression where `Markup.child(at:)` began returning
        markup with incorrect metadata resulting in out-of-bounds errors.

        The `indexInParent` value of a child is unrelated to the parent's
        `indexInParent`. This was missed initially because tests were only
        checking for children of the first item where `indexInParent` would
        be 0. A new test has been added that asserts `Markup.child(at:)` returns
        correct values for children of nested items as well.

    commit 7a7c59d1160fddd23e2379ec5ee8c71df7fd0b3b
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Fri May 20 18:53:24 2022 -0700

        Improve performance of `Markup.child(at:)` method (apple#44)

        Improves the performance of `Markup.child(at:)` by refactoring to removing
        the need to iterate over all previous elements in the child array.

    commit 36cf89e36e94b025dbe37d82fe2a7da3f39d4204
    Author: Franklin Schrans <fschrans@apple.com>
    Date:   Wed Mar 23 14:38:18 2022 +0100

        Remove extraneous print in test (apple#33)

    commit e50693584310a9190071c96c839485b6f2376832
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Mon Mar 21 10:42:02 2022 -0700

        Publish Swift Markdown's documentation to GitHub pages (apple#32)

        * Adopt the Swift-DocC Plugin for documentation generation

        * Add a script for publishing docs to GitHub pages

        * Add missing license headers

        * Move README docs to articles in the DocC catalog

        * Remove out-of-date documentation about `DiagnosticEngine`

        Swift markdown no longer includes a DiagnosticEngine so these links were failing
        to resolve.

    commit 5f10cfb030f43222a49ea34857ff07f02f1e38b0
    Author: christopherweems <github@christopherweems.com>
    Date:   Sat Mar 19 12:53:31 2022 -0400

        Fix typo in documentation for `MarkupVisitor` (apple#26)

        Co-authored-by: Christopher Weems <hello@christopherweems.com>
ethan-kusters added a commit to ethan-kusters/swift-docc that referenced this pull request May 22, 2022
Updates swift-markdown to include:

    commit 97df6e2812adcf8698204ca5f0756563ef36e5c1
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Sat May 21 14:02:22 2022 -0700

        Correctly set `indexInParent` in `Markup.child(at:)` (apple#45)

        This fixes a recent regression where `Markup.child(at:)` began returning
        markup with incorrect metadata resulting in out-of-bounds errors.

        The `indexInParent` value of a child is unrelated to the parent's
        `indexInParent`. This was missed initially because tests were only
        checking for children of the first item where `indexInParent` would
        be 0. A new test has been added that asserts `Markup.child(at:)` returns
        correct values for children of nested items as well.

    commit 7a7c59d1160fddd23e2379ec5ee8c71df7fd0b3b
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Fri May 20 18:53:24 2022 -0700

        Improve performance of `Markup.child(at:)` method (apple#44)

        Improves the performance of `Markup.child(at:)` by refactoring to removing
        the need to iterate over all previous elements in the child array.

    commit 36cf89e36e94b025dbe37d82fe2a7da3f39d4204
    Author: Franklin Schrans <fschrans@apple.com>
    Date:   Wed Mar 23 14:38:18 2022 +0100

        Remove extraneous print in test (apple#33)

    commit e50693584310a9190071c96c839485b6f2376832
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Mon Mar 21 10:42:02 2022 -0700

        Publish Swift Markdown's documentation to GitHub pages (apple#32)

        * Adopt the Swift-DocC Plugin for documentation generation

        * Add a script for publishing docs to GitHub pages

        * Add missing license headers

        * Move README docs to articles in the DocC catalog

        * Remove out-of-date documentation about `DiagnosticEngine`

        Swift markdown no longer includes a DiagnosticEngine so these links were failing
        to resolve.

    commit 5f10cfb030f43222a49ea34857ff07f02f1e38b0
    Author: christopherweems <github@christopherweems.com>
    Date:   Sat Mar 19 12:53:31 2022 -0400

        Fix typo in documentation for `MarkupVisitor` (apple#26)

        Co-authored-by: Christopher Weems <hello@christopherweems.com>
ethan-kusters added a commit to ethan-kusters/swift-docc that referenced this pull request May 22, 2022
Updates swift-markdown to include:

    commit 97df6e2812adcf8698204ca5f0756563ef36e5c1
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Sat May 21 14:02:22 2022 -0700

        Correctly set `indexInParent` in `Markup.child(at:)` (apple#45)

        This fixes a recent regression where `Markup.child(at:)` began returning
        markup with incorrect metadata resulting in out-of-bounds errors.

        The `indexInParent` value of a child is unrelated to the parent's
        `indexInParent`. This was missed initially because tests were only
        checking for children of the first item where `indexInParent` would
        be 0. A new test has been added that asserts `Markup.child(at:)` returns
        correct values for children of nested items as well.

    commit 7a7c59d1160fddd23e2379ec5ee8c71df7fd0b3b
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Fri May 20 18:53:24 2022 -0700

        Improve performance of `Markup.child(at:)` method (apple#44)

        Improves the performance of `Markup.child(at:)` by refactoring to removing
        the need to iterate over all previous elements in the child array.

    commit 36cf89e36e94b025dbe37d82fe2a7da3f39d4204
    Author: Franklin Schrans <fschrans@apple.com>
    Date:   Wed Mar 23 14:38:18 2022 +0100

        Remove extraneous print in test (apple#33)

    commit e50693584310a9190071c96c839485b6f2376832
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Mon Mar 21 10:42:02 2022 -0700

        Publish Swift Markdown's documentation to GitHub pages (apple#32)

        * Adopt the Swift-DocC Plugin for documentation generation

        * Add a script for publishing docs to GitHub pages

        * Add missing license headers

        * Move README docs to articles in the DocC catalog

        * Remove out-of-date documentation about `DiagnosticEngine`

        Swift markdown no longer includes a DiagnosticEngine so these links were failing
        to resolve.

    commit 5f10cfb030f43222a49ea34857ff07f02f1e38b0
    Author: christopherweems <github@christopherweems.com>
    Date:   Sat Mar 19 12:53:31 2022 -0400

        Fix typo in documentation for `MarkupVisitor` (apple#26)

        Co-authored-by: Christopher Weems <hello@christopherweems.com>
ethan-kusters added a commit to ethan-kusters/swift-docc that referenced this pull request May 22, 2022
Updates swift-markdown to include:

    commit 97df6e2812adcf8698204ca5f0756563ef36e5c1
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Sat May 21 14:02:22 2022 -0700

        Correctly set `indexInParent` in `Markup.child(at:)` (apple#45)

        This fixes a recent regression where `Markup.child(at:)` began returning
        markup with incorrect metadata resulting in out-of-bounds errors.

        The `indexInParent` value of a child is unrelated to the parent's
        `indexInParent`. This was missed initially because tests were only
        checking for children of the first item where `indexInParent` would
        be 0. A new test has been added that asserts `Markup.child(at:)` returns
        correct values for children of nested items as well.

    commit 7a7c59d1160fddd23e2379ec5ee8c71df7fd0b3b
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Fri May 20 18:53:24 2022 -0700

        Improve performance of `Markup.child(at:)` method (apple#44)

        Improves the performance of `Markup.child(at:)` by refactoring to removing
        the need to iterate over all previous elements in the child array.

    commit 36cf89e36e94b025dbe37d82fe2a7da3f39d4204
    Author: Franklin Schrans <fschrans@apple.com>
    Date:   Wed Mar 23 14:38:18 2022 +0100

        Remove extraneous print in test (apple#33)

    commit e50693584310a9190071c96c839485b6f2376832
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Mon Mar 21 10:42:02 2022 -0700

        Publish Swift Markdown's documentation to GitHub pages (apple#32)

        * Adopt the Swift-DocC Plugin for documentation generation

        * Add a script for publishing docs to GitHub pages

        * Add missing license headers

        * Move README docs to articles in the DocC catalog

        * Remove out-of-date documentation about `DiagnosticEngine`

        Swift markdown no longer includes a DiagnosticEngine so these links were failing
        to resolve.

    commit 5f10cfb030f43222a49ea34857ff07f02f1e38b0
    Author: christopherweems <github@christopherweems.com>
    Date:   Sat Mar 19 12:53:31 2022 -0400

        Fix typo in documentation for `MarkupVisitor` (apple#26)

        Co-authored-by: Christopher Weems <hello@christopherweems.com>
ethan-kusters added a commit to ethan-kusters/swift-docc that referenced this pull request May 22, 2022
Updates swift-markdown to include:

    commit 97df6e2812adcf8698204ca5f0756563ef36e5c1
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Sat May 21 14:02:22 2022 -0700

        Correctly set `indexInParent` in `Markup.child(at:)` (apple#45)

        This fixes a recent regression where `Markup.child(at:)` began returning
        markup with incorrect metadata resulting in out-of-bounds errors.

        The `indexInParent` value of a child is unrelated to the parent's
        `indexInParent`. This was missed initially because tests were only
        checking for children of the first item where `indexInParent` would
        be 0. A new test has been added that asserts `Markup.child(at:)` returns
        correct values for children of nested items as well.

    commit 7a7c59d1160fddd23e2379ec5ee8c71df7fd0b3b
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Fri May 20 18:53:24 2022 -0700

        Improve performance of `Markup.child(at:)` method (apple#44)

        Improves the performance of `Markup.child(at:)` by refactoring to removing
        the need to iterate over all previous elements in the child array.

    commit 36cf89e36e94b025dbe37d82fe2a7da3f39d4204
    Author: Franklin Schrans <fschrans@apple.com>
    Date:   Wed Mar 23 14:38:18 2022 +0100

        Remove extraneous print in test (apple#33)

    commit e50693584310a9190071c96c839485b6f2376832
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Mon Mar 21 10:42:02 2022 -0700

        Publish Swift Markdown's documentation to GitHub pages (apple#32)

        * Adopt the Swift-DocC Plugin for documentation generation

        * Add a script for publishing docs to GitHub pages

        * Add missing license headers

        * Move README docs to articles in the DocC catalog

        * Remove out-of-date documentation about `DiagnosticEngine`

        Swift markdown no longer includes a DiagnosticEngine so these links were failing
        to resolve.

    commit 5f10cfb030f43222a49ea34857ff07f02f1e38b0
    Author: christopherweems <github@christopherweems.com>
    Date:   Sat Mar 19 12:53:31 2022 -0400

        Fix typo in documentation for `MarkupVisitor` (apple#26)

        Co-authored-by: Christopher Weems <hello@christopherweems.com>
ethan-kusters added a commit to ethan-kusters/swift-docc that referenced this pull request May 23, 2022
Updates swift-markdown to include:

    commit 97df6e2812adcf8698204ca5f0756563ef36e5c1
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Sat May 21 14:02:22 2022 -0700

        Correctly set `indexInParent` in `Markup.child(at:)` (apple#45)

        This fixes a recent regression where `Markup.child(at:)` began returning
        markup with incorrect metadata resulting in out-of-bounds errors.

        The `indexInParent` value of a child is unrelated to the parent's
        `indexInParent`. This was missed initially because tests were only
        checking for children of the first item where `indexInParent` would
        be 0. A new test has been added that asserts `Markup.child(at:)` returns
        correct values for children of nested items as well.

    commit 7a7c59d1160fddd23e2379ec5ee8c71df7fd0b3b
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Fri May 20 18:53:24 2022 -0700

        Improve performance of `Markup.child(at:)` method (apple#44)

        Improves the performance of `Markup.child(at:)` by refactoring to removing
        the need to iterate over all previous elements in the child array.

    commit 36cf89e36e94b025dbe37d82fe2a7da3f39d4204
    Author: Franklin Schrans <fschrans@apple.com>
    Date:   Wed Mar 23 14:38:18 2022 +0100

        Remove extraneous print in test (apple#33)

    commit e50693584310a9190071c96c839485b6f2376832
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Mon Mar 21 10:42:02 2022 -0700

        Publish Swift Markdown's documentation to GitHub pages (apple#32)

        * Adopt the Swift-DocC Plugin for documentation generation

        * Add a script for publishing docs to GitHub pages

        * Add missing license headers

        * Move README docs to articles in the DocC catalog

        * Remove out-of-date documentation about `DiagnosticEngine`

        Swift markdown no longer includes a DiagnosticEngine so these links were failing
        to resolve.

    commit 5f10cfb030f43222a49ea34857ff07f02f1e38b0
    Author: christopherweems <github@christopherweems.com>
    Date:   Sat Mar 19 12:53:31 2022 -0400

        Fix typo in documentation for `MarkupVisitor` (apple#26)

        Co-authored-by: Christopher Weems <hello@christopherweems.com>
ethan-kusters added a commit that referenced this pull request May 25, 2022
Updates swift-markdown to include:

    commit 97df6e2812adcf8698204ca5f0756563ef36e5c1
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Sat May 21 14:02:22 2022 -0700

        Correctly set `indexInParent` in `Markup.child(at:)` (#45)

        This fixes a recent regression where `Markup.child(at:)` began returning
        markup with incorrect metadata resulting in out-of-bounds errors.

        The `indexInParent` value of a child is unrelated to the parent's
        `indexInParent`. This was missed initially because tests were only
        checking for children of the first item where `indexInParent` would
        be 0. A new test has been added that asserts `Markup.child(at:)` returns
        correct values for children of nested items as well.

    commit 7a7c59d1160fddd23e2379ec5ee8c71df7fd0b3b
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Fri May 20 18:53:24 2022 -0700

        Improve performance of `Markup.child(at:)` method (#44)

        Improves the performance of `Markup.child(at:)` by refactoring to removing
        the need to iterate over all previous elements in the child array.

    commit 36cf89e36e94b025dbe37d82fe2a7da3f39d4204
    Author: Franklin Schrans <fschrans@apple.com>
    Date:   Wed Mar 23 14:38:18 2022 +0100

        Remove extraneous print in test (#33)

    commit e50693584310a9190071c96c839485b6f2376832
    Author: Ethan Kusters <ekusters@apple.com>
    Date:   Mon Mar 21 10:42:02 2022 -0700

        Publish Swift Markdown's documentation to GitHub pages (#32)

        * Adopt the Swift-DocC Plugin for documentation generation

        * Add a script for publishing docs to GitHub pages

        * Add missing license headers

        * Move README docs to articles in the DocC catalog

        * Remove out-of-date documentation about `DiagnosticEngine`

        Swift markdown no longer includes a DiagnosticEngine so these links were failing
        to resolve.

    commit 5f10cfb030f43222a49ea34857ff07f02f1e38b0
    Author: christopherweems <github@christopherweems.com>
    Date:   Sat Mar 19 12:53:31 2022 -0400

        Fix typo in documentation for `MarkupVisitor` (#26)

        Co-authored-by: Christopher Weems <hello@christopherweems.com>
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

2 participants