braverock / braverock/quantstrat
[R-Forge #5773] Documentation is inconsistent on providing return values
- Dominant language
- R
- Stars
- 310
- Forks
- 121
- PR merge metrics
- No merged PRs in 30d
Description
Submitted by: Doug Service
Assigned to: Nobody
[R-Forge link](http://r-forge.r-project.org/tracker/index.php?func=detail&aid=5773&group_id=316&atid=1269)
The documentation for
add.paramset()
add.constraint()
add.distribution.constraint()
should be updated to be consistent with the documentation for add.signal(), add.indicator() and other quantstrat functions that take a strategy and possibly return one based on the value of the store parameter. For example, the add.signal() documentation has the following return value discussion.
Value
if strategy was the name of a strategy, the name. It it was a strategy, the updated strategy.
Contributor guide
Research direction
Compare the documentation for add.paramset(), add.constraint(), and add.distribution.constraint() with add.signal(), add.indicator(), and other quantstrat functions that accept a strategy and store value. Start by locating these function documentation entries in the package. Done means their Value sections consistently describe the returned strategy name or updated strategy.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100