Make stanc output compatible with source markers API for RStudio
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 1.1k
- Forks
- 266
- Avg merge
- 2h 56m
- Merged PRs (30d)
- 1
Description
According to
https://github.com/rstudio/rstudioapi/blob/master/man/sourceMarkers.Rd#L28-L33
RStudio's source marker API expects an named list with 5 elements
type: Marker type ("error", "warning", "info", or "style")file: Path to source fileline: Line number witin source filecolumn: Line number witin source filemessage: Short descriptive message
@bob-carpenter rstan can redirect stanc output to a temporary file and parse that, we just need to ensure the stanc output is amenable to parsing. Also, when a user attempts to use a valid function but calls it with an invalid signature, there is an unshort level of output that suggests relevant signatures for that function, so we may have to ask RStudio to expand the API to allow an optional novel.
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 with the sourceMarkers.Rd API documentation linked in the issue and inspect the stanc output format that rstan would need to parse. Determine whether the output can provide the five marker fields, including handling invalid signatures, and confirm completion when it is compatible with the API or the required API limitation is clearly resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100