Chore: No line continuations in usage guides

[amotl]

About

A few more little fixes and improvements.

References

• Windows: Broken line continuation in command-line examples for PowerShell #326

[coderabbitai]

Walkthrough

Minor documentation edits across integration guides: wording and examples updated in the Dapr guide (explicit "Submit"/escaped SQL and explicit close operation), the InfluxDB index expanded into Server API and Line protocol workflows while removing the Synopsis from the InfluxDB usage page, and the Superset guide's CrateDB startup example simplified.

Changes

Cohort / File(s)	Change Summary
Dapr integration documentation docs/integrate/dapr/usage.md	Use "Submit" for query and exec operation headings; escape SQL inside JSON payload examples; add explicit closing payload with "operation": "close"; capitalize and punctuate final instruction.
InfluxDB integration documentation (index) docs/integrate/influxdb/index.md	Replace single "Synopsis" with two workflows: "Synopsis (Server API)" and "Synopsis (Line protocol)"; add Server API and Line protocol examples and corresponding query snippets.
InfluxDB usage documentation docs/integrate/influxdb/usage.md	Remove the Synopsis section (including Server API and Line Protocol subsections and their command examples).
Superset integration documentation docs/integrate/superset/usage.md	Simplify CrateDB startup example to a minimal Docker/Podman-agnostic command (docker run --rm --publish=4200:4200 docker.io/crate '-Cdiscovery.type=single-node'); remove port 5432 mapping, container name, and CRATE_HEAP_SIZE; update cleanup note to reflect --rm.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer (docs)
    participant Client as App -> Dapr
    participant Dapr as Dapr Bindings
    participant Crate as CrateDB

    rect rgb(220,240,255)
    Note over Client,Dapr: Submit query/exec (explicit "Submit")
    Client->>Dapr: POST /v1.0/bindings/cratedb { "operation":"Submit", "data": { ... } }
    Dapr->>Crate: Execute SQL (exec/SELECT)
    Crate-->>Dapr: Result / ACK
    Dapr-->>Client: Response
    end

    rect rgb(240,255,220)
    Note over Client,Dapr: Explicit close operation (new)
    Client->>Dapr: POST /v1.0/bindings/cratedb { "operation":"close" }
    Dapr->>Crate: Close connection pool
    Crate-->>Dapr: Closed
    Dapr-->>Client: Confirmation
    end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Inspect new InfluxDB examples in docs/integrate/influxdb/index.md for correctness and completeness.
• Verify escaped SQL strings and explicit "operation": "close" in docs/integrate/dapr/usage.md match Dapr binding semantics.
• Confirm the simplified Superset startup command is consistent with other docs and intended platform-agnostic guidance.

Possibly related PRs

• Superset: Usage guides #282 — Overlapping edits to docs/integrate/superset/usage.md (startup/run examples).
• Diátaxis: Index how-to guides and tutorials #364 — Edits related to docs/integrate/influxdb/usage.md and Index changes.

Suggested reviewers

• hammerhead

Poem

🐰 Hopping through the README glade,

I tidy examples, line and trade.
Dapr now says "Submit" and closes clean,
Influx split two ways — neat and lean.
Superset starts light; the guide's well made.

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings, 1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The pull request title states "Chore: No line continuations in usage guides," suggesting the primary focus is removing line continuations from documentation. However, the actual changes shown in the summary include diverse modifications across multiple files: SQL payload string escaping fixes in dapr/usage.md, header capitalization updates, synopsis reorganization in influxdb files, and Docker command simplifications in superset/usage.md. These changes do not clearly reflect a cohesive theme of addressing line continuations, making the title appear misaligned with the actual changeset scope.
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.
Description Check	❓ Inconclusive	The pull request description states "A few more little fixes and improvements" with a reference to GH-326. While the description is clearly on-topic and relates to the changeset, it uses entirely non-descriptive language that conveys no meaningful information about what specific fixes or improvements are being made. The description is so vague that it could apply to almost any maintenance PR, providing no insight into the actual scope or nature of the changes.	Enhance the description by listing specific categories of changes or improvements being made. For example, mention that documentation is being updated across multiple integration guides for formatting consistency, SQL examples, and Docker command simplification. This would provide reviewers and future readers with a clear understanding of the PR's scope.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch no-line-continuations-in-usage-guides

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3470ab8 and 8974c74.

📒 Files selected for processing (1)

• docs/integrate/dapr/usage.md (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/integrate/dapr/usage.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build docs

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}