Skip to content

Commit 0f535a8

Browse files
Clean up docs for Rails::Generators::ActiveModel [ci-skip]
Without additional formatting, these method docs render as a single line. For example, ```ruby # GET show # GET edit # PATCH/PUT update # DELETE destroy ``` renders as ```html <p>GET show GET edit PATCH/PUT update DELETE destroy</p> ```
1 parent 4c98fc2 commit 0f535a8

File tree

1 file changed

+26
-12
lines changed

1 file changed

+26
-12
lines changed

railties/lib/rails/generators/active_model.rb

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,21 +32,27 @@ def initialize(name)
3232
@name = name
3333
end
3434

35-
# GET index
35+
# Used for:
36+
#
37+
# * GET +index+
3638
def self.all(klass)
3739
"#{klass}.all"
3840
end
3941

40-
# GET show
41-
# GET edit
42-
# PATCH/PUT update
43-
# DELETE destroy
42+
# Used for:
43+
#
44+
# * GET +show+
45+
# * GET +edit+
46+
# * PATCH / PUT +update+
47+
# * DELETE +destroy+
4448
def self.find(klass, params = nil)
4549
"#{klass}.find(#{params})"
4650
end
4751

48-
# GET new
49-
# POST create
52+
# Used for:
53+
#
54+
# * GET +new+
55+
# * POST +create+
5056
def self.build(klass, params = nil)
5157
if params
5258
"#{klass}.new(#{params})"
@@ -55,23 +61,31 @@ def self.build(klass, params = nil)
5561
end
5662
end
5763

58-
# POST create
64+
# Used for:
65+
#
66+
# * POST +create+
5967
def save
6068
"#{name}.save"
6169
end
6270

63-
# PATCH/PUT update
71+
# Used for:
72+
#
73+
# * PATCH / PUT +update+
6474
def update(params = nil)
6575
"#{name}.update(#{params})"
6676
end
6777

68-
# POST create
69-
# PATCH/PUT update
78+
# Used for:
79+
#
80+
# * POST +create+
81+
# * PATCH / PUT +update+
7082
def errors
7183
"#{name}.errors"
7284
end
7385

74-
# DELETE destroy
86+
# Used for:
87+
#
88+
# * DELETE +destroy+
7589
def destroy
7690
"#{name}.destroy!"
7791
end

0 commit comments

Comments
 (0)