Skip to content

docs/examples.md still says MicroDataFrame.cov() and .corr() are unweighted #335

Description

@MaxGhenis

docs/examples.md line 44 says:

MicroDataFrame.cov() and .corr() retain pandas' unweighted calculations and return plain pandas DataFrame matrices.

The first clause has been false since #330 merged (2026-09-18): both are frequency-weighted, and each cell of the matrix is the estimator applied to that pair of columns. docs/api.md already says so. A reader who checks the docs against the code finds a direct contradiction.

Fix: rewrite the paragraph to describe the weighted behaviour, keep the accurate note that the return type is a plain DataFrame, and add a two-line example whose numbers match numpy.cov(fweights=...) on the replicated sample.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions