Skip to content

fix: convert remaining rst docstrings#1244

Merged
AngeloDanducci merged 3 commits into
generative-computing:mainfrom
AngeloDanducci:ad-1172
Jun 22, 2026
Merged

fix: convert remaining rst docstrings#1244
AngeloDanducci merged 3 commits into
generative-computing:mainfrom
AngeloDanducci:ad-1172

Conversation

@AngeloDanducci

Copy link
Copy Markdown
Contributor

Pull Request

Issue

Fixes #1172

Description

Converts remaining RST docstrings

Testing

  • Tests added to the respective file if code was changed
  • New code has 100% coverage if code was added
  • Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

Attribution

  • AI coding assistants used

Adding a new component, requirement, sampling strategy, or tool?

If your PR adds or modifies one of the types below, check the matching box. A checklist of type-specific review items will be posted as a comment.

  • Component
  • Requirement
  • Sampling Strategy
  • Tool

NOTE: Please ensure you have an issue that has been acknowledged by a core contributor and routed you to open a pull request against this repository. Otherwise, please open an issue before continuing with this pull request.

Signed-off-by: AngeloDanducci <angelo.danducci.ii@ibm.com>
@AngeloDanducci AngeloDanducci requested review from a team, jakelorocco and nrfulton as code owners June 10, 2026 05:14
@AngeloDanducci AngeloDanducci requested a review from markstur June 10, 2026 05:14
@github-actions github-actions Bot added the bug Something isn't working label Jun 10, 2026

@planetf1 planetf1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A few gaps in the RST conversion — details inline.

Comment thread mellea/stdlib/tools/interpreter.py
Comment thread mellea/stdlib/tools/interpreter.py
Comment thread mellea/stdlib/tools/interpreter.py
Comment thread mellea/formatters/granite/base/io.py Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread mellea/stdlib/components/intrinsic/core.py Outdated
Signed-off-by: AngeloDanducci <angelo.danducci.ii@ibm.com>
@AngeloDanducci AngeloDanducci enabled auto-merge June 12, 2026 04:13

@planetf1 planetf1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the follow-up commit — the issues I flagged in the first round are all resolved: the Example: and Deprecated: fences in interpreter.py are in place, the CONTRIBUTING.md fence nesting is correct (4-backtick outer, 3-backtick inner), and the documents type annotation in intrinsic/core.py is now present. Approving with a few small suggestions below.

Comment thread mellea/stdlib/requirements/python_reqs.py
Comment thread mellea/stdlib/components/intrinsic/core.py Outdated
Comment thread mellea/formatters/granite/granite3/input.py
Comment thread mellea/core/utils.py Outdated

@markstur markstur left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

some args are lost when converting from init doc to class docs.

Also Nigel already pointed out a Note indent problem.

Comment thread mellea/formatters/granite/intrinsics/output.py
Signed-off-by: AngeloDanducci <angelo.danducci.ii@ibm.com>
@ajbozarth ajbozarth mentioned this pull request Jun 15, 2026
8 tasks

@planetf1 planetf1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM — all inline comments and suggestions addressed in the latest commit.

@AngeloDanducci AngeloDanducci added this pull request to the merge queue Jun 22, 2026
Merged via the queue into generative-computing:main with commit e81ba32 Jun 22, 2026
9 checks passed
@AngeloDanducci AngeloDanducci deleted the ad-1172 branch June 22, 2026 21:14
@planetf1

Copy link
Copy Markdown
Contributor

Follow-up: #1336 tracks the remaining RST directives not covered by this PR (5 files with structural directives, plus a note that a broader scan for inline :func:/:class: roles should be done before the sweep is considered complete).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: convert remaining RST docstring constructs to Google style

4 participants