Skip to content

Format all files#208

Merged
sriramveeraghanta merged 1 commit intomasterfrom
format-all-files
Feb 6, 2026
Merged

Format all files#208
sriramveeraghanta merged 1 commit intomasterfrom
format-all-files

Conversation

@sriramveeraghanta
Copy link
Member

@sriramveeraghanta sriramveeraghanta commented Feb 6, 2026

Summary by CodeRabbit

Release Notes

  • Documentation
    • Standardized code example formatting across API reference documentation.
    • Updated JavaScript fetch call examples with consistent indentation and trailing comma conventions.
    • Refined whitespace and line breaks in code blocks for improved readability.

@vercel
Copy link

vercel bot commented Feb 6, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
developer-docs Ready Ready Preview, Comment Feb 6, 2026 9:52am

Request Review

@coderabbitai
Copy link

coderabbitai bot commented Feb 6, 2026

📝 Walkthrough

Walkthrough

This pull request reformats API reference documentation files across multiple modules (customer, cycle, epics, inbox-issue). Changes include consolidating multi-line JavaScript fetch calls to single-line invocations, adding trailing commas in object literals, converting quoted object keys to unquoted identifiers, adjusting indentation schemes, and removing extraneous blank lines. No behavioral or semantic changes to documented APIs.

Changes

Cohort / File(s) Summary
Customer API Documentation
docs/api-reference/customer/add-customer-property.md, add-customer-request.md, add-customer.md, delete-customer-property.md, delete-customer-request.md, delete-customer.md, get-customer-detail.md, get-customer-property-detail.md, get-customer-property-value.md, get-customer-request-detail.md, link-work-items-to-customer.md, list-customer-properties.md, list-customer-property-values.md, list-customer-requests.md, list-customer-work-items.md, list-customers.md, overview.md, unlink-work-item-from-customer.md, update-customer-detail.md, update-customer-property-detail.md, update-customer-property-value.md, update-customer-request-detail.md
Reformatted JavaScript fetch examples from multi-line to single-line calls; added trailing commas in object literals; converted quoted object keys to unquoted identifiers; removed extra blank lines; adjusted indentation from tabs to spaces in JSON examples.
Cycle API Documentation
docs/api-reference/cycle/add-cycle-work-items.md, add-cycle.md, archive-cycle.md, delete-cycle.md, get-cycle-detail.md, list-archived-cycles.md, list-cycle-work-items.md, list-cycles.md, overview.md, remove-cycle-work-item.md, transfer-cycle-work-items.md, unarchive-cycle.md, update-cycle-detail.md
Consolidated fetch calls to single-line format; added trailing commas in headers and body objects; converted quoted keys to unquoted identifiers in JSON payloads; removed blank lines for compact formatting.
Epics API Documentation
docs/api-reference/epics/get-epic-detail.md, list-epics.md, overview.md
Refactored fetch examples to single-line calls with trailing commas; reformatted JSON from multi-line to compact format; adjusted indentation consistency.
Inbox-Issue API Documentation
docs/api-reference/inbox-issue/add-inbox-issue.md, delete-inbox-issue.md, get-inbox-issue-detail.md, list-inbox-issues.md, overview.md, update-inbox-issue-detail.md
Removed extraneous blank lines around API parameter blocks; added trailing commas in fetch headers; converted quoted object keys to unquoted identifiers; standardized indentation in JSON examples.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Hops through docs with comma care,
Single-line fetches float through air,
Keys unquoted, spaces aligned,
Formatting polish, refined and designed,
Rabbit rejoices—the docs now gleam!

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Format all files' is overly vague and generic. It uses non-descriptive language that doesn't convey specific information about the actual changes, which focus on JavaScript code formatting in API documentation files. Use a more specific title that describes the actual formatting changes, such as 'Standardize JavaScript code examples formatting in API docs' or 'Add trailing commas and reformat fetch calls in API documentation'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch format-all-files

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

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

@sriramveeraghanta sriramveeraghanta merged commit 59064ac into master Feb 6, 2026
4 of 5 checks passed
@sriramveeraghanta sriramveeraghanta deleted the format-all-files branch February 6, 2026 15:04
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.

2 participants