Documentation for integrated_time still specifies discontinued ``axis`` keyword argument
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.6k
- Forks
- 440
- PR merge metrics
- No merged PRs in 30d
Description
General information:
- emcee version: 3.0.2
- platform: MacOS X
- installation method (pip/conda/source/other?): pip
Problem description:
The docstring for the integrated_time function still mentions the argument 'axis', which does not seem to be implemented anymore. It would be great if the axis argument could be specified, to avoid having to swap axes before passing to this function.
See lines 47 onwards in autocorr.py
"""Estimate the integrated autocorrelation time of a time series.
This estimate uses the iterative procedure described on page 16 of
`Sokal's notes <http://www.stat.unc.edu/faculty/cji/Sokal.pdf>`_ to
determine a reasonable window size.
Args:
x: The time series. If multidimensional, set the time axis using the
``axis`` keyword argument and the function will be computed for
every other axis.
Contributor guide
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 in autocorr.py at lines 47 onward and inspect the integrated_time entry point, comparing its current signature and behavior with the docstring's axis description. Clarify whether the intended outcome is to remove the obsolete documentation or support axis, then ensure the documentation accurately reflects the resolved behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100