Skip to content

Commit 10eff92

Browse files
igerberclaude
andcommitted
Address PR #410 R3 P2+P3: plot_bacon placement + template whitespace
R3 findings: - P2: plot_bacon section was inserted before plot_group_time_heatmap's Example block, so the heatmap example rendered under the plot_bacon heading. Reordered to put plot_bacon AFTER the heatmap example, and added a real plot_bacon example. - P3: docs/_templates/autosummary/class.rst had {% block %} tags with 3-space indent that produced trailing-whitespace blank lines in every generated stub. Switched the block tags to column 0 (no indent) so Jinja control flow doesn't leak indentation into the rendered output. Regenerated all 50 class stubs - now whitespace-clean. Verified: 0 ERRORs / 0 WARNINGs, 0 stubs with trailing whitespace, git diff --check passes, page-level rendering preserved (286 <dt count on api/results.html, 1 class header on stub). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 6a55a9a commit 10eff92

62 files changed

Lines changed: 428 additions & 596 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,26 @@
1-
{{ fullname | escape | underline}}
1+
{{ fullname | escape | underline }}
22

33
.. currentmodule:: {{ module }}
44

55
.. autoclass:: {{ objname }}
66
:no-members:
7-
8-
{% block methods %}
9-
{% if methods %}
7+
{% block methods %}
8+
{% if methods %}
109
.. rubric:: {{ _('Methods') }}
1110

1211
.. autosummary::
13-
{% for item in methods %}
12+
{% for item in methods %}
1413
~{{ name }}.{{ item }}
15-
{%- endfor %}
16-
{% endif %}
17-
{% endblock %}
18-
19-
{% block attributes %}
20-
{% if attributes %}
14+
{%- endfor %}
15+
{% endif %}
16+
{% endblock %}
17+
{% block attributes %}
18+
{% if attributes %}
2119
.. rubric:: {{ _('Attributes') }}
2220

2321
.. autosummary::
24-
{% for item in attributes %}
22+
{% for item in attributes %}
2523
~{{ name }}.{{ item }}
26-
{%- endfor %}
27-
{% endif %}
28-
{% endblock %}
24+
{%- endfor %}
25+
{% endif %}
26+
{% endblock %}

docs/api/_autosummary/diff_diff.BaconDecomposition.rst

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,18 @@
66
.. autoclass:: BaconDecomposition
77
:no-members:
88

9-
10-
9+
1110
.. rubric:: Methods
1211

1312
.. autosummary::
14-
13+
1514
~BaconDecomposition.__init__
1615
~BaconDecomposition.fit
1716
~BaconDecomposition.get_params
1817
~BaconDecomposition.print_summary
1918
~BaconDecomposition.set_params
2019
~BaconDecomposition.summary
21-
22-
2320

24-
25-
26-
21+
22+
23+

docs/api/_autosummary/diff_diff.BaconDecompositionResults.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,25 @@
66
.. autoclass:: BaconDecompositionResults
77
:no-members:
88

9-
10-
9+
1110
.. rubric:: Methods
1211

1312
.. autosummary::
14-
13+
1514
~BaconDecompositionResults.__init__
1615
~BaconDecompositionResults.effect_by_type
1716
~BaconDecompositionResults.print_summary
1817
~BaconDecompositionResults.summary
1918
~BaconDecompositionResults.to_dataframe
2019
~BaconDecompositionResults.weight_by_type
21-
22-
2320

24-
25-
21+
22+
23+
2624
.. rubric:: Attributes
2725

2826
.. autosummary::
29-
27+
3028
~BaconDecompositionResults.decomposition_error
3129
~BaconDecompositionResults.n_obs
3230
~BaconDecompositionResults.survey_metadata
@@ -41,5 +39,4 @@
4139
~BaconDecompositionResults.n_timing_groups
4240
~BaconDecompositionResults.n_never_treated
4341
~BaconDecompositionResults.timing_groups
44-
45-
42+

docs/api/_autosummary/diff_diff.CSBootstrapResults.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,20 @@
66
.. autoclass:: CSBootstrapResults
77
:no-members:
88

9-
10-
9+
1110
.. rubric:: Methods
1211

1312
.. autosummary::
14-
13+
1514
~CSBootstrapResults.__init__
16-
17-
1815

19-
20-
16+
17+
18+
2119
.. rubric:: Attributes
2220

2321
.. autosummary::
24-
22+
2523
~CSBootstrapResults.bootstrap_distribution
2624
~CSBootstrapResults.cband_crit_value
2725
~CSBootstrapResults.event_study_cis
@@ -39,5 +37,4 @@
3937
~CSBootstrapResults.group_time_ses
4038
~CSBootstrapResults.group_time_cis
4139
~CSBootstrapResults.group_time_p_values
42-
43-
40+

docs/api/_autosummary/diff_diff.CallawaySantAnna.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,30 @@
66
.. autoclass:: CallawaySantAnna
77
:no-members:
88

9-
10-
9+
1110
.. rubric:: Methods
1211

1312
.. autosummary::
14-
13+
1514
~CallawaySantAnna.__init__
1615
~CallawaySantAnna.diagnose_propensity
1716
~CallawaySantAnna.fit
1817
~CallawaySantAnna.get_params
1918
~CallawaySantAnna.print_summary
2019
~CallawaySantAnna.set_params
2120
~CallawaySantAnna.summary
22-
23-
2421

25-
26-
22+
23+
24+
2725
.. rubric:: Attributes
2826

2927
.. autosummary::
30-
28+
3129
~CallawaySantAnna.n_bootstrap
3230
~CallawaySantAnna.bootstrap_weights
3331
~CallawaySantAnna.alpha
3432
~CallawaySantAnna.seed
3533
~CallawaySantAnna.anticipation
3634
~CallawaySantAnna.base_period
37-
38-
35+

docs/api/_autosummary/diff_diff.CallawaySantAnnaResults.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,24 @@
66
.. autoclass:: CallawaySantAnnaResults
77
:no-members:
88

9-
10-
9+
1110
.. rubric:: Methods
1211

1312
.. autosummary::
14-
13+
1514
~CallawaySantAnnaResults.__init__
1615
~CallawaySantAnnaResults.epv_summary
1716
~CallawaySantAnnaResults.print_summary
1817
~CallawaySantAnnaResults.summary
1918
~CallawaySantAnnaResults.to_dataframe
20-
21-
2219

23-
24-
20+
21+
22+
2523
.. rubric:: Attributes
2624

2725
.. autosummary::
28-
26+
2927
~CallawaySantAnnaResults.alpha
3028
~CallawaySantAnnaResults.anticipation
3129
~CallawaySantAnnaResults.att
@@ -62,5 +60,4 @@
6260
~CallawaySantAnnaResults.n_obs
6361
~CallawaySantAnnaResults.n_treated_units
6462
~CallawaySantAnnaResults.n_control_units
65-
66-
63+

docs/api/_autosummary/diff_diff.ChaisemartinDHaultfoeuille.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,25 @@
66
.. autoclass:: ChaisemartinDHaultfoeuille
77
:no-members:
88

9-
10-
9+
1110
.. rubric:: Methods
1211

1312
.. autosummary::
14-
13+
1514
~ChaisemartinDHaultfoeuille.__init__
1615
~ChaisemartinDHaultfoeuille.fit
1716
~ChaisemartinDHaultfoeuille.get_params
1817
~ChaisemartinDHaultfoeuille.set_params
19-
20-
2118

22-
23-
19+
20+
21+
2422
.. rubric:: Attributes
2523

2624
.. autosummary::
27-
25+
2826
~ChaisemartinDHaultfoeuille.n_bootstrap
2927
~ChaisemartinDHaultfoeuille.bootstrap_weights
3028
~ChaisemartinDHaultfoeuille.alpha
3129
~ChaisemartinDHaultfoeuille.seed
32-
33-
30+

docs/api/_autosummary/diff_diff.ChaisemartinDHaultfoeuilleResults.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,23 @@
66
.. autoclass:: ChaisemartinDHaultfoeuilleResults
77
:no-members:
88

9-
10-
9+
1110
.. rubric:: Methods
1211

1312
.. autosummary::
14-
13+
1514
~ChaisemartinDHaultfoeuilleResults.__init__
1615
~ChaisemartinDHaultfoeuilleResults.print_summary
1716
~ChaisemartinDHaultfoeuilleResults.summary
1817
~ChaisemartinDHaultfoeuilleResults.to_dataframe
19-
20-
2118

22-
23-
19+
20+
21+
2422
.. rubric:: Attributes
2523

2624
.. autosummary::
27-
25+
2826
~ChaisemartinDHaultfoeuilleResults.L_max
2927
~ChaisemartinDHaultfoeuilleResults.alpha
3028
~ChaisemartinDHaultfoeuilleResults.att
@@ -93,5 +91,4 @@
9391
~ChaisemartinDHaultfoeuilleResults.n_groups_dropped_crossers
9492
~ChaisemartinDHaultfoeuilleResults.n_groups_dropped_singleton_baseline
9593
~ChaisemartinDHaultfoeuilleResults.n_groups_dropped_never_switching
96-
97-
94+

docs/api/_autosummary/diff_diff.Comparison2x2.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,20 @@
66
.. autoclass:: Comparison2x2
77
:no-members:
88

9-
10-
9+
1110
.. rubric:: Methods
1211

1312
.. autosummary::
14-
13+
1514
~Comparison2x2.__init__
16-
17-
1815

19-
20-
16+
17+
18+
2119
.. rubric:: Attributes
2220

2321
.. autosummary::
24-
22+
2523
~Comparison2x2.treated_group
2624
~Comparison2x2.control_group
2725
~Comparison2x2.comparison_type
@@ -30,5 +28,4 @@
3028
~Comparison2x2.n_treated
3129
~Comparison2x2.n_control
3230
~Comparison2x2.time_window
33-
34-
31+

docs/api/_autosummary/diff_diff.ContinuousDiD.rst

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,16 @@
66
.. autoclass:: ContinuousDiD
77
:no-members:
88

9-
10-
9+
1110
.. rubric:: Methods
1211

1312
.. autosummary::
14-
13+
1514
~ContinuousDiD.__init__
1615
~ContinuousDiD.fit
1716
~ContinuousDiD.get_params
1817
~ContinuousDiD.set_params
19-
20-
2118

22-
23-
24-
19+
20+
21+

0 commit comments

Comments
 (0)