REditorSupport / REditorSupport/languageserver
rich documentation markdown conversion fails for some `arguments` sections
Open
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 675
- Forks
- 118
- Avg merge
- 1d 37m
- Merged PRs (30d)
- 11
Description
When requesting the hover for e.g. the source function, the Arguments section ends up as raw htm instead of (pandoc's or github's) markdown
### Arguments
<table>
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<tbody>
<tr class="odd">
<td><code>file</code></td>
<td><p>a connection or a character string giving the pathname of the file or URL to read from. The <code>stdin()</code> connection reads from the console when interactive.</p></td>
</tr>
<tr class="even">
....
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the hover for the R source function and trace the rich documentation markdown conversion that produces the Arguments section. Compare the raw HTML table shown in the issue with the expected Markdown rendering; done when that section is converted correctly rather than displayed as raw HTML.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100