docs(api): normalize source docstring backticks#659
Conversation
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
|
|
Thanks @Kemalau; I've pinged this issue in another PR that one of our docs maintainers opened to fix this issue in a different way. I think your solution is good; we just need to add a rule to prevent merges with this syntax in the future. We'll see what they say in the other PR. |
|
Thanks for PR @Kemalau . The intent of the PR looks good - aligned with issue. |
|
Note - We have a template we use for PRs. I suggest copying the format from another PR (use the same comment line at top, section headings, and check boxes from another PR marked as Misc.) Save it. then merge your text back into that format afterwards. That should make the PR Box go green. |
|
@planetf1 do we think we could shepherd this over the line now that the doc rewrites are mostly done? |
|
Thanks @Kemalau for the contribution and for identifying the issue. The PR fell too far behind main to rebase cleanly (206 intervening commits touching many of the same files), so I've opened a fresh branch in #1155 that applies the same fix on current main. Closing this in favour of that PR — your work was the starting point for it. |
Replace RST-style ``symbol`` notation with Markdown-style `symbol` notation in Python string literals under mellea/ and cli/. Keeps fenced code blocks (triple backticks) intact. Fresh branch off main, superseding PR generative-computing#659. Fixes generative-computing#657. Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
Replace RST-style ``symbol`` notation with Markdown-style `symbol` notation in Python string literals under mellea/ and cli/. Keeps fenced code blocks (triple backticks) intact. Fresh branch off main, superseding PR generative-computing#659. Fixes generative-computing#657. Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
…#1155) * docs(api): normalize source docstring backticks Replace RST-style ``symbol`` notation with Markdown-style `symbol` notation in Python string literals under mellea/ and cli/. Keeps fenced code blocks (triple backticks) intact. Fresh branch off main, superseding PR generative-computing#659. Fixes generative-computing#657. Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com> * docs(api): fix malformed docstring in session.py Pre-existing RST typo: ``return_sampling_results`` was missing its opening double-backtick, leaving a dangling backtick after the bulk normalisation. Correct the full inline-code span. Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com> --------- Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
…#1155) * docs(api): normalize source docstring backticks Replace RST-style ``symbol`` notation with Markdown-style `symbol` notation in Python string literals under mellea/ and cli/. Keeps fenced code blocks (triple backticks) intact. Fresh branch off main, superseding PR generative-computing#659. Fixes generative-computing#657. Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com> * docs(api): fix malformed docstring in session.py Pre-existing RST typo: ``return_sampling_results`` was missing its opening double-backtick, leaving a dangling backtick after the bulk normalisation. Correct the full inline-code span. Assisted-by: Claude Code Signed-off-by: Nigel Jones <jonesn@uk.ibm.com> --------- Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
Why
The docstring source still contains RST-style double backticks across the Python package and CLI, so the docs pipeline has to normalize them at generation time. Cleaning up the source keeps the docstrings consistent with the project's Markdown/Google-style convention and addresses issue #657 directly.
What changed
symbolnotation with Markdown-stylesymbolnotation in Python string literals undermellea/andcli/Verification
python -m compileall mellea climellea/andcli/for remaining inline double-backtick occurrences after the replacement (only triple-backtick fence literals remain)Fixes #657