fix: adjust documentation display

[JoviDeCroock]

Resolve #124

There are probably more possible improvements, looking at what it produces from an urql TSDoc...

  "body": {
    "kind": "alias",
    "kindModifiers": "declare",
    "start": {
      "line": 39,
      "offset": 1
    },
    "end": {
      "line": 39,
      "offset": 13
    },
    "displayString": "(alias) createClient(opts: ClientOptions): Client\nimport createClient",
    "documentation": [
      {
        "text": "Accepts `ClientOptions` and creates a `Client`.",
        "kind": "text"
      }
    ],
    "tags": [
      {
        "name": "param",
        "text": [
          {
            "text": "opts",
            "kind": "parameterName"
          },
          {
            "text": " ",
            "kind": "space"
          },
          {
            "text": "- A ",
            "kind": "text"
          },
          {
            "text": "{@link ",
            "kind": "link"
          },
          {
            "text": "ClientOptions",
            "kind": "linkName",
            "target": {
              "file": "/Users/jovi/Documents/SideProjects/GraphQLSP/node_modules/.pnpm/@[email protected][email protected]/node_modules/@urql/core/dist/urql-core-chunk.d.ts",
              "start": {
                "line": 12,
                "offset": 1
              },
              "end": {
                "line": 133,
                "offset": 2
              }
            }
          },
          {
            "text": "}",
            "kind": "link"
          },
          {
            "text": " objects with options for the `Client`.",
            "kind": "text"
          }
        ]
      },
      {
        "name": "returns",
        "text": [
          {
            "text": "A ",
            "kind": "text"
          },
          {
            "text": "{@link ",
            "kind": "link"
          },
          {
            "text": "Client",
            "kind": "linkName",
            "target": {
              "file": "/Users/jovi/Documents/SideProjects/GraphQLSP/node_modules/.pnpm/@[email protected][email protected]/node_modules/@urql/core/dist/urql-core-chunk.d.ts",
              "start": {
                "line": 440,
                "offset": 15
              },
              "end": {
                "line": 440,
                "offset": 58
              }
            }
          },
          {
            "text": "}",
            "kind": "link"
          },
          {
            "text": " instantiated with `opts`.",
            "kind": "text"
          }
        ]
      }
    ]
  }

[changeset-bot]

🦋 Changeset detected

Latest commit: 4f3f32f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@0no-co/graphqlsp	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[kitten]

I'm admittedly a bit confused about this. It looks like displayString may be reserved for code-like references, while documentation is only for "meta" information?

This could correspond to the hover string, where displayString might be displayed in monospace, while documentation is the smaller sans-serif text below it, if I'm not mistaken

[JoviDeCroock]

Yes, it's a tad smaller... Not sure how to combine displayString though as that expects code it looks like