Uploaded image for project: 'Swift'
  1. Swift
  2. SR-15408

Building documentation with a fallback display name that includes a space produces a broken-looking article

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Open
    • Priority: Medium
    • Resolution: Unresolved
    • Component/s: Swift-DocC
    • Labels:
    • Environment:

      Reproduced with commit hash ba393152de75579fe4c60a8d7da2b3a719c31998 on the main branch.

      Description

      If I pass a fallback display name with a space (like --fallback-display-name "My Display Name") to docc, along with a valid symbol graph, DocC generates an article with ``My Display Name`` as the H1 heading and organizes it under an “Articles” topic group on my top-level framework page. I don’t expect this article to be created at all.

       

      Reproduction Steps:

      1. Download the attached symbol graph
      2. Run the following:
      docc preview --fallback-display-name "Tiny Framework" --fallback-bundle-identifier TinyFramework --fallback-bundle-version 1 --additional-symbol-graph-files /path/to/Tiny_Framework.symbols.json
      

       

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            ekusters Ethan Kusters
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated: