rdoc-markdown 0.10.0 → 0.10.2
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/.yard-lint.yml +1 -0
- data/CHANGELOG.md +10 -0
- data/Gemfile.lock +1 -1
- data/lib/rdoc/generator/markdown.rb +0 -7
- data/lib/rdoc/markdown/version.rb +1 -4
- data/lib/templates/classfile.md.erb +4 -12
- 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: 7f62c96dacb7b3f4987b9d48f3f949ac37ee0abe715288139d937f9085e63097
|
|
4
|
+
data.tar.gz: 7a8326a4247d835f83694707f03a851c1a1c676fc40cf29fcfc9e682f6226480
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e332801e5958e9f91342c62b2df262270a38386624257835d68ed96c97b4d3a113f9d4d89b723abc5387239dd9425a93accc485bb534b582cfc629ba03f8dce6
|
|
7
|
+
data.tar.gz: cd8a226680fbc336396b23b2f90cfcbe1bf78822426ad538ede0bd44f6e7bd05f0defdf01c2af8b7083fc4aa835c761e527824a727782d19754f74bd8f93773f
|
data/.yard-lint.yml
CHANGED
data/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
## Unreleased
|
|
4
4
|
|
|
5
|
+
## 0.10.2
|
|
6
|
+
|
|
7
|
+
### Fixed
|
|
8
|
+
- Generated anchors stay inline with headings
|
|
9
|
+
|
|
10
|
+
## 0.10.1
|
|
11
|
+
|
|
12
|
+
### Changed
|
|
13
|
+
- Stop adding a global "Type signatures available" notice to generated class/module pages.
|
|
14
|
+
|
|
5
15
|
## 0.10.0
|
|
6
16
|
|
|
7
17
|
- Reworked RDoc 8 support
|
data/Gemfile.lock
CHANGED
|
@@ -403,13 +403,6 @@ class RDoc::Generator::Markdown
|
|
|
403
403
|
signatures.join(" | ")
|
|
404
404
|
end
|
|
405
405
|
|
|
406
|
-
# Checks whether this documentation set has parsed RBS signatures.
|
|
407
|
-
#
|
|
408
|
-
# @return [Boolean] True when type signatures are available.
|
|
409
|
-
def types_available?
|
|
410
|
-
@rbs_method_signatures.any?
|
|
411
|
-
end
|
|
412
|
-
|
|
413
406
|
# Merges RDoc parameter names into a type-only signature.
|
|
414
407
|
#
|
|
415
408
|
# @param signature [String] Method signature from RDoc call sequence.
|
|
@@ -1,9 +1,4 @@
|
|
|
1
|
-
# <%= klass.type.capitalize %> <%= display_name(klass) %>
|
|
2
|
-
<%= anchor(klass.aref.strip) %>
|
|
3
|
-
<%- if types_available? -%>
|
|
4
|
-
|
|
5
|
-
_Type signatures available._
|
|
6
|
-
<%- end -%>
|
|
1
|
+
# <%= klass.type.capitalize %> <%= display_name(klass) %> <%= anchor(klass.aref.strip) %>
|
|
7
2
|
<%- class_description = describe(klass) -%>
|
|
8
3
|
<%- unless class_description.empty? -%>
|
|
9
4
|
|
|
@@ -26,8 +21,7 @@ _Type signatures available._
|
|
|
26
21
|
### Constants
|
|
27
22
|
<% constants.sort_by(&:name).each do |const| -%>
|
|
28
23
|
|
|
29
|
-
#### `<%= const.name %>`
|
|
30
|
-
<%= anchor(const.name) %>
|
|
24
|
+
#### `<%= const.name %>` <%= anchor(const.name) %>
|
|
31
25
|
|
|
32
26
|
<%= describe(const, fallback: "Not documented.", heading_level_offset: 4) %>
|
|
33
27
|
<% end -%>
|
|
@@ -37,8 +31,7 @@ _Type signatures available._
|
|
|
37
31
|
### Attributes
|
|
38
32
|
<% attributes.sort_by(&:name).each do |attr| -%>
|
|
39
33
|
|
|
40
|
-
#### `<%= attr.name %>` [<%= attr.rw %>]
|
|
41
|
-
<%= anchor(attr.aref.strip) %>
|
|
34
|
+
#### `<%= attr.name %>` [<%= attr.rw %>] <%= anchor(attr.aref.strip) %>
|
|
42
35
|
|
|
43
36
|
<%= describe(attr, fallback: "Not documented.", heading_level_offset: 4) %>
|
|
44
37
|
<% end -%>
|
|
@@ -51,8 +44,7 @@ _Type signatures available._
|
|
|
51
44
|
### <%= visibility.capitalize %> <%= type.capitalize %> Methods
|
|
52
45
|
<% methods.each do |method| -%>
|
|
53
46
|
|
|
54
|
-
#### `<%= method.name %><%= method_signature(method) %>`
|
|
55
|
-
<%= anchor(method.aref) %>
|
|
47
|
+
#### `<%= method.name %><%= method_signature(method) %>` <%= anchor(method.aref) %>
|
|
56
48
|
|
|
57
49
|
<%= method_description(method, current_class: klass) %>
|
|
58
50
|
<% end -%>
|