1
0
mirror of https://github.com/onkelbeh/cheatsheets.git synced 2026-08-15 21:44:51 +02:00

Update rdoc.md (#1832)

Co-authored-by: Rico Sta. Cruz <rstacruz@users.noreply.github.com>
This commit is contained in:
Christophe Bliard
2022-05-19 14:58:57 +02:00
committed by GitHub
parent f142dce3f3
commit e7d44f5f8c

15
rdoc.md
View File

@@ -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.
* <https://docs.ruby-lang.org/en/2.1.0/RDoc/Markup.html>
* <https://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md>
* <https://rubydoc.info/gems/yard/file/docs/Tags.md>
{: .-also-see}