Very minor mistake in cmdstanr model-method-compile help page

Interfaces
,
1

On the model-method-compile help page from the cmdstanr package, there is a trivial mistake in the description of the “pedantic” argument.

The link there to the “Pedantic mode” subchapter in the Stan User’s Guide is described in the text as being from the Stan Reference Manual.

The link itself otherwise works fine.

Edit: the link text calls that section of the UG “chapter”, though I would call it “subchapter” of the “Using the Stan Compiler” chapter of the appendices. But this may be hair-splitting.

  • Operating System: MacOS 14.5
  • CmdStan Version: 0.8.1.9000
  • Compiler/Toolkit: XCode 15.4
2

Thanks. I created an issue on GitHub under cmdstanr (the interfaces other than cmdstan manage their own doc):

It’s very easy to generate a PR to fix if you can find the page that generated it—there’s a visual editor you can pop up with a button to create the PR. If you don’t want to bother, we’ll fix.

3

Thanks Bob. I didn’t see this feature but will make sure to look again if a similar situation arises.

I tried to edit this file itself (line 398) myself, but it made me fork the whole project, which I really didn’t want to do!

4

There’s an “edit this file” button on the header that just pulls up an editor.

Then when you’re done, there’s a “Commit Changes…” button, where the “…” is the universal signal that it’s going to pop up a dialog box. When it does that, it gives you the option to “create a new branch”, which is what you want to do. Then it opens the PR, which you just need to submit.

I just did it for this one, to make sure it still worked.

Does it work differently for you without merge privileges?

5

I think I lack necessary privileges. I did find the editing facility but when I tried to commit, it said I lacked access and could only fork the project.

But as I’ve only been on github for a few weeks, I guess I’d need to earn them first. No prob though, glad I can help in any way.

6

Yeah I think you’d need to fork it and create a pull request from your fork. That’d definitely doable, but no need since @Bob_Carpenter took care of it. Thanks to you both!

7

The GitHub file edit functionality offers to create that fork, and creates the PR so it is easy. After the PR has been merged, the forked repo can be removed which is also easy to do. If you have questions about the process don’t hesitate to ask more.

The branch option requires that you are added as a contributor with write permission to the original repo.

1 Like