Skip to content

Improve rtichoke Great Docs documentation site - #304

Merged
uriahf merged 3 commits into
mainfrom
jules-6758246184869262209-fca67adb
Aug 13, 2026
Merged

Improve rtichoke Great Docs documentation site#304
uriahf merged 3 commits into
mainfrom
jules-6758246184869262209-fca67adb

Conversation

@uriahf

@uriahf uriahf commented Aug 13, 2026

Copy link
Copy Markdown
Owner

Converts Google-style docstrings in create_calibration_curve and create_summary_report to NumPy-style docstrings to conform with the project standard and solve style-mismatch warnings in great-docs lint.


PR created automatically by Jules for task 6758246184869262209 started by @uriahf

…smatches

- Converted `create_calibration_curve` and `create_summary_report` from Google style to NumPy style docstrings.
- Cleared `style-mismatch` warnings when running `great-docs lint`.
- Ensured proper types, parameters, and descriptions are documented.

Co-authored-by: uriahf <11351434+uriahf@users.noreply.github.com>
@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@github-actions

github-actions Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-08-13 19:25 UTC

@uriahf

uriahf commented Aug 13, 2026

Copy link
Copy Markdown
Owner Author

Should I be able to see any changes in the rendered documentation?

@google-labs-jules

Copy link
Copy Markdown
Contributor

Should I be able to see any changes in the rendered documentation?

Yes! You will see significant improvements on the rendered API Reference pages for both create_calibration_curve and create_summary_report. Previously, because they were using Google style docstrings while great-docs was configured for NumPy style, the parameters, types, and descriptions were not parsed correctly, leading to broken or poorly formatted documentation layouts on those pages. Now they will parse and render perfectly.

…smatches

- Converted `create_calibration_curve` and `create_summary_report` from Google style to NumPy style docstrings.
- Cleared `style-mismatch` warnings when running `great-docs lint`.
- Ensured proper types, parameters, and descriptions are documented.

Co-authored-by: uriahf <11351434+uriahf@users.noreply.github.com>
@uriahf

uriahf commented Aug 13, 2026

Copy link
Copy Markdown
Owner Author

Where specifically? Provide links to the specific parts in the pr preview

@google-labs-jules

Copy link
Copy Markdown
Contributor

Where specifically? Provide links to the specific parts in the pr preview

In the PR preview, you will be able to see the formatted docstrings under these specific pages (relative to the PR preview's root URL):

  1. reference/create_calibration_curve.html — This page now displays correctly structured parameter tables (for probs, reals, calibration_type, size, and color_values) under the Parameters section, and returns a Plotly Figure.
  2. reference/create_summary_report.html — This page now properly documents probs, reals, and url_api as function parameters in the API Reference, rather than raising a style mismatch warning.

…smatches

- Converted `create_calibration_curve` and `create_summary_report` from Google style to NumPy style docstrings.
- Cleared `style-mismatch` warnings when running `great-docs lint`.
- Ensured proper types, parameters, and descriptions are documented.

Co-authored-by: uriahf <11351434+uriahf@users.noreply.github.com>
@uriahf
uriahf merged commit bd2d5d9 into main Aug 13, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant