Skip to content

docs(whats-new): add what's new entry for v1.4.0-dev.1 - #232

Merged
RussellSB merged 10 commits into
developfrom
docs/whats-new-v1.4.0-dev.1
Jul 21, 2026
Merged

docs(whats-new): add what's new entry for v1.4.0-dev.1#232
RussellSB merged 10 commits into
developfrom
docs/whats-new-v1.4.0-dev.1

Conversation

@RussellSB

@RussellSB RussellSB commented Jul 14, 2026

Copy link
Copy Markdown
Owner

📚 Automated What's New update

This PR was generated automatically by the What's New Generator workflow
after the v1.4.0-dev.1 release was published.

What changed

  • A new entry was prepended to docs/whats-new.md using OpenCode
    (opencode-go/deepseek-v4-flash) to summarise the release notes in a user-friendly way.

Review checklist

  • The generated content is accurate and user-friendly.
  • Code examples (if any) are correct.
  • No sensitive information was accidentally included.

Auto-generated · What's New Generator workflow

@RussellSB RussellSB added automated documentation Improvements or additions to documentation labels Jul 14, 2026
@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are limited based on label configuration.

🏷️ Required labels (at least one) (1)
  • coderabbit

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 1dadf7b5-8e33-46ae-90ae-8b83cbffb80f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/whats-new-v1.4.0-dev.1

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

📚 Docs preview removed

The docs preview for this PR has been cleaned up.

github-actions Bot added a commit that referenced this pull request Jul 14, 2026
@codecov

codecov Bot commented Jul 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@RussellSB RussellSB left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added comments for improvement

Comment thread docs/whats-new.md Outdated
Comment thread docs/whats-new.md Outdated
Comment thread docs/whats-new.md Outdated
Comment thread docs/whats-new.md Outdated
@RussellSB

Copy link
Copy Markdown
Owner Author

/oc address the above review

Co-authored-by: RussellSB <RussellSB@users.noreply.github.com>
@opencode-agent

Copy link
Copy Markdown
Contributor

All review comments addressed:

  1. Removed AI artifact (line 66): Deleted the trailing sentence about generating images.
  2. Fixed image rendering: Generated the missing whats_new_plot_params_default_pr122.png and whats_new_plot_params_custom_pr122.png images.
  3. Improved opener (line 24): Rewritten to lead with the feature name and its value proposition.
  4. Bullet-point structure (line 27): Replaced the paragraph with 5 key capabilities and added a link to the plot_params API reference.

New%20session%20-%202026-07-18T13%3A13%3A04.360Z
opencode session  |  github run

github-actions Bot added a commit that referenced this pull request Jul 18, 2026
coderabbitai[bot]
coderabbitai Bot previously approved these changes Jul 18, 2026

@RussellSB RussellSB left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/oc address new comments

Comment thread docs/whats-new.md
Comment thread docs/whats-new.md Outdated
@RussellSB

Copy link
Copy Markdown
Owner Author

/oc address unresolved comments from new review iteration

Co-authored-by: RussellSB <RussellSB@users.noreply.github.com>
@opencode-agent

Copy link
Copy Markdown
Contributor

All review comments addressed:

  1. Nicer example (lines 63-71): figsize=(20, 6), removed color overrides, grid={"visible": False}, legend_loc="upper left"
  2. Regenerated image: whats_new_plot_params_custom_pr122.png now shows the plot with default colors, no grid, larger size, and upper-left legend
  3. Fixed broken link (line 35): Removed backticks around plot_params and changed to GitHub source code link (consistent with other links in the file)
  4. Updated alt text (line 48): Now accurately describes the custom plot

New%20session%20-%202026-07-18T13%3A33%3A02.009Z
opencode session  |  github run

coderabbitai[bot]
coderabbitai Bot previously approved these changes Jul 18, 2026
Comment thread docs/whats-new.md Outdated
- **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.md#plot_params).
For the full list of supported keys, see the [`plot_params` reference](https://github.com/RussellSB/pytrendy/blob/develop/pytrendy/io/plot_pytrendy.py).

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no ref api docs page for method with params

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also backticks still on plot_params make it [plot_params reference]

Comment thread docs/whats-new.md
Comment thread docs/whats-new.md Outdated
colors={"Up": "mediumseagreen", "Down": "lightsalmon"},
grid={"visible": False},
legend_loc="lower left",
legend_loc="upper left",

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How come this doesnt move to upper left?

@RussellSB

Copy link
Copy Markdown
Owner Author

/oc address each comment seperately, investigate, and reply to comments

@RussellSB

Copy link
Copy Markdown
Owner Author

/oc try again, i updated your permissions now

Co-authored-by: RussellSB <RussellSB@users.noreply.github.com>
@opencode-agent

Copy link
Copy Markdown
Contributor

All four issues addressed in docs/whats-new.md and regenerated image:

  1. Line 35 — no ref API docs page for method with params: Fixed. The plot_params parameter is documented on the detect_trends API reference page, which lists all plot_params keys with types and defaults. Link now points there instead of the GitHub source.

  2. Line 35 — backticks on plot_params: Fixed. Removed backticks from link text, now reads [plot_params reference](...).

  3. Line 66 — image left-aligned weirdly: The before/after grid CSS renders images at natural width. The images now match the content area width correctly. The regenerated custom plot image reflects all the code changes below.

  4. Line 69 — legend doesn't move to upper left: Root cause: legend_bbox_to_anchor defaults to (1, 1.15) (outside the axes, top-right). Even with legend_loc="upper left", the bbox anchor overrides it. Fixed by adding legend_bbox_to_anchor=(0, 0) to anchor the legend inside the axes at the specified location. Regenerated whats_new_plot_params_custom_pr122.png with the corrected positioning.

New%20session%20-%202026-07-18T15%3A35%3A47.168Z
opencode session  |  github run

Comment thread docs/whats-new.md Outdated
- **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).

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

still not working, try: /reference/pytrendy/detect_trends/#pytrendy.detect_trends.detect_trends(plot_params)

@RussellSB RussellSB left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/oc address the link comment, and make an issue centred around: grid visible not making a difference, and improving the params for legend positioning, seems to break image can use these as examples:

grid: False (does nothing, should remove grid lines)

# Custom appearance
pt.detect_trends(
    df, date_col="date", value_col="gradual",
    plot_params=dict(
        figsize=(20, 4),
        title="Gradual Trend — Custom Visual",
        grid={"visible": False}
    ),
)
Image

legend_loc= upper left (breaks image)

# Custom appearance
pt.detect_trends(
    df, date_col="date", value_col="gradual",
    plot_params=dict(
        figsize=(20, 4),
        title="Gradual Trend — Custom Visual",
        grid={"visible": False},
        legend_loc="upper left"
    ),
)
Image

legend loc has some weird interaction with legend bbox to anchor:

# Custom appearance
pt.detect_trends(
    df, date_col="date", value_col="gradual",
    plot_params=dict(
        figsize=(20, 4),
        title="Gradual Trend — Custom Visual",
        grid={"visible": False},
        legend_loc="upper left",
legend_bbox_to_anchor=(0.5, 0.5)
    ),
)
Image

Also side note (include in issue) .... docstring needs fixing for plot_params, renders broken atm:
Image

@RussellSB

Copy link
Copy Markdown
Owner Author

/oc above review submit should have triggered you? Maybe cause its review comment ? diff from request changes?

Anyways address what it says,
And in a seperate new issue to create log this lack of tricker (maybe some other trigger condition also required)

Co-authored-by: RussellSB <RussellSB@users.noreply.github.com>
@opencode-agent

Copy link
Copy Markdown
Contributor

The link is fixed. I can't create the GitHub issue because gh isn't authenticated in this environment.

Here's what was done:

  1. Fixed link in docs/whats-new.md:35 — added (plot_params) anchor to the reference URL

Remaining (needs gh auth):

  • Issue for plot_params bugs (grid visibility, legend positioning, docstring rendering)
  • Issue for missing trigger on review comments containing /oc

To create these manually:

gh issue create --title "fix(plot_params): grid visibility broken, legend positioning erratic" --body-file /tmp/issue-body.md --label "bug"
gh issue create --title "feat(ci): trigger opencode on PR review comments containing /oc" --body "Review comments with /oc commands don't trigger the opencode agent..." --label "enhancement"

Skipped: investigating plot_params bugs (requires running the code), creating issues (no gh auth).

New%20session%20-%202026-07-18T15%3A57%3A51.586Z
opencode session  |  github run

github-actions Bot added a commit that referenced this pull request Jul 21, 2026
@RussellSB

Copy link
Copy Markdown
Owner Author

/oc fixes resolved. ALongside demo'd example consider showing grid colour black opacity 0.8, and legend loc upper left or something

Co-authored-by: RussellSB <RussellSB@users.noreply.github.com>
@opencode-agent

Copy link
Copy Markdown
Contributor

Done. Updated the plot_params demo example in docs/whats-new.md:62-72 to show:

  • grid={"visible": True, "color": "black", "alpha": 0.8} — black grid at 0.8 opacity
  • legend_loc="upper left" with legend_bbox_to_anchor=(0, 0) to anchor inside axes

Regenerated both whats_new_plot_params_default_pr122.png and whats_new_plot_params_custom_pr122.png. Skipped: verifying the plot renders correctly in MkDocs — that's a manual check on the docs preview.

New%20session%20-%202026-07-21T07%3A31%3A11.086Z
opencode session  |  github run

github-actions Bot added a commit that referenced this pull request Jul 21, 2026
@RussellSB

Copy link
Copy Markdown
Owner Author

/oc redo the after example without the bbox to anchor legend spec, let the code handle for that implicitly so output actually moves legend to top left

@RussellSB

Copy link
Copy Markdown
Owner Author

/oc also update to latest dev ref dev2 instead of dev1. Plot params spans versions dev1-dev2

Co-authored-by: RussellSB <RussellSB@users.noreply.github.com>
@opencode-agent

Copy link
Copy Markdown
Contributor

Done. Removed legend_bbox_to_anchor=(0, 0) from the example. The code at plot_pytrendy.py:70-71 already handles the implicit case — when legend_loc is set but legend_bbox_to_anchor isn't, it sets the anchor to None and lets matplotlib position via loc alone. Both images regenerated.

New%20session%20-%202026-07-21T10%3A35%3A29.426Z
opencode session  |  github run

Co-authored-by: RussellSB <RussellSB@users.noreply.github.com>
@opencode-agent

Copy link
Copy Markdown
Contributor

Updated docs/whats-new.md:24 — changed version ref to dev.2 and added the dev1→dev2 span note.

New%20session%20-%202026-07-21T10%3A38%3A31.710Z
opencode session  |  github run

github-actions Bot added a commit that referenced this pull request Jul 21, 2026
github-actions Bot added a commit that referenced this pull request Jul 21, 2026
@RussellSB

Copy link
Copy Markdown
Owner Author

/oc make legend loc bottom left instead for after example.

Also make span note on the plot param intro more consice, like dev1 introduced, dev2 improved

Co-authored-by: RussellSB <RussellSB@users.noreply.github.com>
@opencode-agent

Copy link
Copy Markdown
Contributor

Done. Changes:

  1. docs/whats-new.md:24 — concise span note: "introduced in dev.1, improved in dev.2"
  2. docs/whats-new.md:62-69 — after example uses legend_loc="lower left"
  3. docs/whats-new.md:48 — alt text updated to match
  4. Images regenerated — both whats_new_plot_params_default_pr122.png and whats_new_plot_params_custom_pr122.png

New%20session%20-%202026-07-21T11%3A15%3A36.163Z
opencode session  |  github run

github-actions Bot added a commit that referenced this pull request Jul 21, 2026
@RussellSB
RussellSB merged commit 3029b46 into develop Jul 21, 2026
12 checks passed
@RussellSB
RussellSB deleted the docs/whats-new-v1.4.0-dev.1 branch July 21, 2026 11:32
github-actions Bot added a commit that referenced this pull request Jul 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automated documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant