Skip to content

[DX-598] Add a method signature component #3181

Open
m-hulbert wants to merge 3 commits intomainfrom
dx-598-method-signature
Open

[DX-598] Add a method signature component #3181
m-hulbert wants to merge 3 commits intomainfrom
dx-598-method-signature

Conversation

@m-hulbert
Copy link
Contributor

@m-hulbert m-hulbert commented Feb 5, 2026

Description

This PR adds a component for styling method signatures in API references.

It can take an unwrapped string, as long as that string doesn't contain special characters such as < - in that case then you can wrap it as an expression in a template literal.

Everything is stripped and replaced as just a code wrapped string (``) for the raw markdown.

You can test on this temporary page: https://ably-docs-dx-598-method-vhhuoj.herokuapp.com/docs/chat/api/chat-client

Checklist

@m-hulbert m-hulbert self-assigned this Feb 5, 2026
@m-hulbert m-hulbert added the review-app Create a Heroku review app label Feb 5, 2026
@coderabbitai
Copy link

coderabbitai bot commented Feb 5, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

  • 🔍 Trigger a full review
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dx-598-method-signature

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.

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

Labels

review-app Create a Heroku review app

Development

Successfully merging this pull request may close these issues.

2 participants