Skip to content

Commit 8b4f4bc

Browse files
update documentations acc. to Refactor Data Generators #306
1 parent 0d07790 commit 8b4f4bc

File tree

3 files changed

+5
-8
lines changed

3 files changed

+5
-8
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,10 @@ body:
2323
attributes:
2424
label: Minimum reproducible code snippet
2525
description: |
26-
Please provide a short reproducible code snippet. Example:
27-
28-
```python
26+
Please provide a short reproducible code snippet. Example: ```python
2927
import numpy as np
3028
import doubleml as dml
31-
from doubleml.datasets import make_plr_CCDDHNR2018
29+
from doubleml.plm.datasets import make_plr_CCDDHNR2018
3230
from sklearn.ensemble import RandomForestRegressor
3331
from sklearn.base import clone
3432
np.random.seed(3141)

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ To submit a **bug report**, you can use our
1515
```python
1616
import numpy as np
1717
import doubleml as dml
18-
from doubleml.datasets import make_plr_CCDDHNR2018
18+
from doubleml.plm.datasets import make_plr_CCDDHNR2018
1919
from sklearn.ensemble import RandomForestRegressor
2020
from sklearn.base import clone
2121
np.random.seed(3141)

doubleml/data/cluster_data.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -171,9 +171,8 @@ def from_arrays(
171171
Default is ``True``.
172172
173173
Examples
174-
--------
175-
>>> from doubleml import DoubleMLClusterData
176-
>>> from doubleml.datasets import make_pliv_multiway_cluster_CKMS2021
174+
-------- >>> from doubleml import DoubleMLClusterData
175+
>>> from doubleml.plm.datasets import make_pliv_multiway_cluster_CKMS2021
177176
>>> (x, y, d, cluster_vars, z) = make_pliv_multiway_cluster_CKMS2021(return_type='array')
178177
>>> obj_dml_data_from_array = DoubleMLClusterData.from_arrays(x, y, d, cluster_vars, z)
179178
"""

0 commit comments

Comments
 (0)