[SourceKit] Document source.request.demangle

[modocache]

What's in this pull request?

Additional docs for source.request.demangle.

/cc @akyrtzi @benlangmuir @briancroom

---

By the way, I noticed this isn't the only SourceKit request that doesn't return JSON, instead returning something like the following:

DELIMITER
One item
Another item
DELIMITER

sourcekitd-test -req=cursor also returns information in this format. Is this the intended behavior? Or should these be converted to return JSON, like the other request types documented in tools/SourceKit/docs/Protocol.md?

Related bug number: SR-2117

---

Before merging this pull request to apple/swift repository:

• Test pull request on Swift continuous integration.

Triggering Swift CI

The swift-ci is triggered by writing a comment on this PR addressed to the GitHub user @swift-ci. Different tests will run depending on the specific comment that you use. The currently available comments are:

Smoke Testing

Platform	Comment
All supported platforms	@swift-ci Please smoke test
All supported platforms	@swift-ci Please smoke test and merge
OS X platform	@swift-ci Please smoke test OS X platform
Linux platform	@swift-ci Please smoke test Linux platform

Validation Testing

Platform	Comment
All supported platforms	@swift-ci Please test
All supported platforms	@swift-ci Please test and merge
OS X platform	@swift-ci Please test OS X platform
OS X platform	@swift-ci Please benchmark
Linux platform	@swift-ci Please test Linux platform

Lint Testing

Language	Comment
Python	@swift-ci Please Python lint

Note: Only members of the Apple organization can trigger swift-ci.

[nkcsgexi]

Hi @modocache, this is intended behavior to facilitate human-readable tests. However, in actual service communication, the format is still in json, both for demangling and for cursor-info.

[modocache]

Ooh, I see! Thanks!! I just tried invoking this via sourcekitd-repl, and got the following:

{
  key.results: [
    {
      key.name: "MyCoolPackage.raichu.getter : MyCoolPackage.Pokemon"
    }
  ]
}

I'll update the documentation to use this format instead. Thanks!

[modocache]

@nkcsgexi Updated -- thanks! Does this look good?

[nkcsgexi]

LGTM! merging.