From e7d44f5f8ccfdfad47f1c957e4329beeff800f83 Mon Sep 17 00:00:00 2001 From: Christophe Bliard Date: Thu, 19 May 2022 14:58:57 +0200 Subject: [PATCH] Update rdoc.md (#1832) Co-authored-by: Rico Sta. Cruz --- rdoc.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/rdoc.md b/rdoc.md index da646a367..4caadf898 100644 --- a/rdoc.md +++ b/rdoc.md @@ -28,7 +28,7 @@ layout: 2017/sheet # @option opts [String] :subject The subject # @option opts [String] :from ('nobody') From address # @option opts [String] :to Recipient email -# @option opts [String] :body ('') The email's body +# @option opts [String] :body ('') The email's body ``` ### Parameter types @@ -46,6 +46,12 @@ layout: 2017/sheet # :format => :dot ``` +### Exceptions +```rb +# @raise [AccountBalanceError] if the account does not have +# sufficient funds to perform the transaction +``` + ### Inline ```markdown @@ -54,6 +60,12 @@ _emphasized_ +code+ ``` +```markdown +{ObjectName#method optional title} +{Class::CONSTANT My constant's title} +{#method_inside_current_namespace} +``` + ```markdown https://www.example.com/ See Models::User@Examples @@ -135,4 +147,5 @@ Place this at the beginning of the file. * * +* {: .-also-see}