diff --git a/docs/img/whats-new/pre-release/whats_new_plot_params_custom_pr122.png b/docs/img/whats-new/pre-release/whats_new_plot_params_custom_pr122.png new file mode 100644 index 00000000..a315f1da Binary files /dev/null and b/docs/img/whats-new/pre-release/whats_new_plot_params_custom_pr122.png differ diff --git a/docs/img/whats-new/pre-release/whats_new_plot_params_default_pr122.png b/docs/img/whats-new/pre-release/whats_new_plot_params_default_pr122.png new file mode 100644 index 00000000..514a40ff Binary files /dev/null and b/docs/img/whats-new/pre-release/whats_new_plot_params_default_pr122.png differ diff --git a/docs/whats-new.md b/docs/whats-new.md index f3e7c004..285c4a86 100644 --- a/docs/whats-new.md +++ b/docs/whats-new.md @@ -3,17 +3,75 @@ Stay up to date with every PyTrendy release — user-facing improvements, bug fixes, and behaviour changes. - +!!! note "Pre-release documentation" + You are viewing the **develop** (pre-release) build. + The section at the top reflects changes staged for the next stable release. + Switch to the **main** docs via the badge in the header to see only stable content. --- +## Coming in v1.4.1 pre-release + +*Staged on the `develop` branch — will land in the next stable release. Currently available as the latest pre-release:* + +```bash +pip install --pre pytrendy +``` + +v1.4.0-dev.2 adds **plot customisation** via a new `plot_params` dict — introduced in dev.1, improved in dev.2. + +??? note "Plot customisation via `plot_params`" + A new `plot_params` dictionary, accepted by both `detect_trends()` and `plot_pytrendy()`, lets you override every visual aspect of the trend-detection plot. Key capabilities: + + - **Figure dimensions** — set `figsize` to control width and height. + - **Title & labels** — add a domain-specific `title`, `xlabel`, or `ylabel`. + - **Colour scheme** — pass a `colors` dict mapping `'Up'`, `'Down'`, `'Flat'`, `'Noise'` to any matplotlib colour. + - **Grid control** — toggle grid visibility and customise its appearance via the `grid` dict. + - **Legend positioning** — move the legend with `legend_loc` and `legend_bbox_to_anchor`. + + For the full list of supported keys, see the [plot_params reference](reference/pytrendy/detect_trends/#pytrendy.detect_trends.detect_trends(plot_params)). + Introduced: [#122](https://github.com/RussellSB/pytrendy/issues/122) + +