documentation-test 0.3.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardopts +1 -0
- data/doc/read-this.md +3 -0
- data/lib/documentation-test.rb +13 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: dfb922215d4b47918ff99d462204d692772d72d9083875777a98a51cdaa5e47f
|
|
4
|
+
data.tar.gz: 329071d811d59ca1fc26acdcc57ba9a809a49ff9df0f5b9ddc175ecd17158b5a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a3ff2910be1984de93672dbf8f15825188228080d1224fc7119a7bf620ce62a47ccd808ce7409a1308c8bf4f02b925d646e05140d4a69b40249be1e92e0d6f60
|
|
7
|
+
data.tar.gz: a6b799ae011429c3f0b7d89bfe12c36162837499bc0f6085d1ae1ae83ba8cc3be509d047d1dfef991c2665e4e557257aaced4d9cc16cb8c4a36d387598bba3ad
|
data/.yardopts
CHANGED
data/doc/read-this.md
CHANGED
data/lib/documentation-test.rb
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
module DocumentationTest
|
|
4
|
+
class SomeClass
|
|
5
|
+
methodify "foo" do
|
|
6
|
+
raise NotImplementedError
|
|
7
|
+
end
|
|
8
|
+
end
|
|
4
9
|
# Does it understand `markdown` ?
|
|
5
10
|
# and +rdoc+ ?
|
|
6
11
|
# @return [String] This is work ?.
|
|
@@ -15,6 +20,14 @@ module DocumentationTest
|
|
|
15
20
|
def to_format(format = :html)
|
|
16
21
|
# format the object
|
|
17
22
|
end
|
|
23
|
+
|
|
24
|
+
# Converts the object into textual markup given a specific format.
|
|
25
|
+
#
|
|
26
|
+
# @param format [Symbol] the format type, `:text` or `:html`
|
|
27
|
+
# @return [String] the object converted into the expected format.
|
|
28
|
+
def to_factory
|
|
29
|
+
# format the object
|
|
30
|
+
end
|
|
18
31
|
end
|
|
19
32
|
|
|
20
33
|
describe(something)
|