Improve rtichoke Great Docs documentation site - #304
Conversation
…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>
|
👋 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 New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
|
|
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 |
…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>
|
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):
|
…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>
Converts Google-style docstrings in
create_calibration_curveandcreate_summary_reportto NumPy-style docstrings to conform with the project standard and solve style-mismatch warnings ingreat-docs lint.PR created automatically by Jules for task 6758246184869262209 started by @uriahf