gleam-lang / gleam-lang/package-interface

Undesired space for documentation

Open
#4 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Gleam
Stars
11
Forks
1
Avg merge
2h 32m
Merged PRs (30d)
1

Description

Hi!

In the documentation fields, there's an undesired leading space for every line.

Here's an example, from the package interface of the `gleam_stdlib` right now (`append` function here):

```jsonc
{
// That field has undesired spaces
"documentation": " Creates a new bit array by joining two bit arrays.\n\n ## Examples\n\n ```gleam\n append(to: from_string(\"butter\"), suffix: from_string(\"fly\"))\n // -> from_string(\"butterfly\")\n ```\n",

// Rest of the definition.
"deprecation": null,
"implementations": {
"gleam": false,
"uses-erlang-externals": true,
"uses-javascript-externals": true,
"can-run-on-erlang": true,
"can-run-on-javascript": true
},
"parameters": [
{
"label": "to",
"type": {
"kind": "named",
"name": "BitArray",
"package": "",
"module": "gleam",
"parameters": [

]
}
},
{
"label": "suffix",
"type": {
"kind": "named",
"name": "BitArray",
"package": "",
"module": "gleam",
"parameters": [

]
}
}
],
"return": {
"kind": "named",
"name": "BitArray",
"package": "",
"module": "gleam",
"parameters": [

]
}
}
```

I suspect it's due to the `///` comments removed, but the space between the triple slash and the comments themselves are still there. It's a bug, because the string as-is is not a valid markdown string.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.