Skip to content

Commit 917b71f

Browse files
committed
DOC: plot_annotation
1 parent 75bac9f commit 917b71f

File tree

2 files changed

+9
-0
lines changed

2 files changed

+9
-0
lines changed

doc/_quartodoc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -541,6 +541,7 @@ quartodoc:
541541
- Stack
542542
- Beside
543543
- Wrap
544+
- plot_annotation
544545
- plot_spacer
545546
- plot_layout
546547

plotnine/composition/_plot_annotation.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@
1515
class plot_annotation(ComposeAddable):
1616
"""
1717
Annotate a composition
18+
19+
This applies to only the top-level composition. When a composition
20+
with an annotation is added to larger composition, the annotation
21+
of the sub-composition becomes irrelevant.
1822
"""
1923

2024
title: str | None = None
@@ -35,6 +39,10 @@ class plot_annotation(ComposeAddable):
3539
theme: theme = field(default_factory=theme) # pyright: ignore[reportUnboundVariable]
3640
"""
3741
Theme to use for the plot title, subtitle, caption, margin and background
42+
43+
It also controls the [](`~plotnine.themes.themeables.figure_size`) of the
44+
composition. The default theme is the same as the default one used for the
45+
plots, which you can change with [](`~plotnine.theme_set`).
3846
"""
3947

4048
def __radd__(self, cmp: Compose) -> Compose:

0 commit comments

Comments
 (0)