stan-dev / stan-dev/docs

CmdStan Guide needs better examples of compiler options

Open
#505 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TeX
Stars
43
Forks
133
Avg merge
11h 32m
Merged PRs (30d)
4

Description

Summary:

It would be good to add to CmdStan user guide a section about how to set different compiler options. Currently the user guide has only the example
CXXFLAGS = -O2
Which is bad, as it is not with += and doesn't even remove -O3 as optimization level should be set with O=2 as dicussed in this thread

Current Version:

v2.29.0

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the CmdStan user guide and find the existing compiler-options example containing CXXFLAGS = -O2. Update the documentation to explain the relevant use of += and O=2, with examples that accurately show how to set compiler options.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.