Upgrading rdoc 6 to 7
Review needed6.17.0 → 7.2.0New4Changed6Fixed25Other41
Review neededUpgrade verdict
6 behavior changes.
In plain terms
- Changes PrismRuby to no longer depend on a hack storing module nesting in context.parent.
- Aligns strikethrough support with GitHub Markdown.
- Sidebar entries in the generated documentation are more compact.
- The default documentation theme looks better.
Must act Nothing to change
No breaking, platform, security or deprecated items in this range.
Nothing in this upgrade needs a code or configuration change.
API changes
Generated by DepDelta from published Ruby source. Not mixed with prose notes.
- removed:
method AnyMethod.name() - removed:
method AnyMethod.param_list() - removed:
method AnyMethod.param_seq() - removed:
method AnyMethod.skip_description?() - removed:
method AnyMethod.superclass_method() - removed:
method CrossReference.resolve_method(_) - removed:
method Markup.add_html(_, _) - removed:
method Markup.add_word_pair(_, _, _) - removed:
property Markup.attribute_manager: reader - removed:
protected method AnyMethod._call_seq() - removed:
set AnyMethod.store(_) - changed:
constructor Markup(_ = …) → constructor Markup() - added:
method ClassModule.legacy_aref() - added:
method ClassModule.search_snippet() - added:
method Constant.search_snippet() - added:
method Context.get_module_named(_) - added:
method CrossReference.resolve_local_symbol(_) - added:
method Markdown.rdoc_escape(_) - added:
method Markdown.rdoc_link_url_escape(_) - added:
method MethodAttr.search_snippet() - added:
method Text.to_html_characters(_) - added:
method TopLevel.get_module_named(_) - added:
method TopLevel.search_snippet() - added:
property Markup.regexp_handlings: reader - added:
static method Text.decode_legacy_label(_) - added:
static method Text.to_anchor(_)
- removed:
property Section.comment: reader - changed:
constructor Section(_, _, _) → constructor Section(_, _, _, _ = …) - added:
method Section.legacy_aref() - added:
property Section.store: reader
- added:
method Aliki.build_search_index() - added:
method Aliki.generate() - added:
method Aliki.resolve_url(_, _) - added:
method Aliki.write_search_index()
- removed:
class AttrChanger < Struct.new - removed:
class AttrSpan - removed:
class AttributeManager - removed:
class Attributes - removed:
class RegexpHandling - removed:
const AttributeManager.A_PROTECT - removed:
const AttributeManager.NON_PRINTING_END - removed:
const AttributeManager.NON_PRINTING_START - removed:
const AttributeManager.NULL - removed:
const AttributeManager.PROTECT_ATTR - removed:
constructor AttrSpan(_, _) - removed:
constructor AttributeManager() - removed:
constructor Attributes() - removed:
constructor RegexpHandling(_, _) - removed:
method AttrChanger.inspect() - removed:
method AttrChanger.to_s() - removed:
method AttrSpan.[](_) - removed:
method AttrSpan.set_attrs(_, _, _) - removed:
method AttributeManager.add_html(_, _, _ = …) - removed:
method AttributeManager.add_regexp_handling(_, _, _ = …) - removed:
method AttributeManager.add_word_pair(_, _, _, _ = …) - removed:
method AttributeManager.attribute(_, _) - removed:
method AttributeManager.change_attribute(_, _) - removed:
method AttributeManager.changed_attribute_by_name(_, _) - removed:
method AttributeManager.convert_attrs(_, _, _ = …) - removed:
method AttributeManager.convert_attrs_matching_word_pairs(_, _, _) - removed:
method AttributeManager.convert_attrs_word_pair_map(_, _, _) - removed:
method AttributeManager.convert_html(_, _, _ = …) - removed:
method AttributeManager.convert_regexp_handlings(_, _, _ = …) - removed:
method AttributeManager.copy_string(_, _) - removed:
method AttributeManager.display_attributes() - removed:
method AttributeManager.exclusive?(_) - removed:
method AttributeManager.flow(_) - removed:
method AttributeManager.mask_protected_sequences() - removed:
method AttributeManager.match_length(_) - removed:
method AttributeManager.split_into_flow() - removed:
method AttributeManager.unmask_protected_sequences() - removed:
method Attributes.as_string(_) - removed:
method Attributes.bitmap_for(_) - removed:
method Attributes.each_name_of(_) - removed:
method Formatter.add_regexp_handling_TIDYLINK() - removed:
method Formatter.add_tag(_, _, _) - removed:
method Formatter.convert_flow(_) - removed:
method Formatter.convert_regexp_handling(_) - removed:
method Formatter.each_attr_tag(_, _ = …) - removed:
method Formatter.in_tt?() - removed:
method Formatter.off_tags(_, _) - removed:
method Formatter.on_tags(_, _) - removed:
method Formatter.tt_tag?(_, _ = …) - removed:
method RegexpHandling.==(_) - removed:
method RegexpHandling.inspect() - removed:
method RegexpHandling.to_s() - removed:
method ToAnsi.init_tags() - removed:
method ToBs.annotate(_) - removed:
method ToBs.convert_regexp_handling(_) - removed:
method ToBs.convert_string(_) - removed:
method ToBs.init_tags() - removed:
method ToHtmlSnippet.handle_regexp_HARD_BREAK(_) - removed:
method ToLabel.handle_regexp_HARD_BREAK() - removed:
method ToLabel.handle_regexp_TIDYLINK(_) - removed:
method ToMarkdown.handle_regexp_HARD_BREAK(_) - removed:
method ToMarkdown.handle_regexp_TIDYLINK(_) - removed:
method ToMarkdown.init_tags() - removed:
method ToRdoc.handle_regexp_HARD_BREAK(_) - removed:
method ToRdoc.init_tags() - removed:
property AttributeManager.attributes: reader - removed:
property AttributeManager.exclusive_bitmap: reader - removed:
property AttributeManager.html_tags: reader - removed:
property AttributeManager.matching_word_pairs: reader - removed:
property AttributeManager.protectable: reader - removed:
property AttributeManager.regexp_handlings: reader - removed:
property AttributeManager.word_pair_map: reader - removed:
property Attributes.regexp_handling: reader - removed:
property RegexpHandling.text: accessor - removed:
property RegexpHandling.type: reader - changed:
class BlankLine → class BlankLine < Element - changed:
class HardBreak → class HardBreak < Element - changed:
class Table → class Table < Element - added:
class Element - added:
class Heading < Element - added:
class InlineParser - added:
const InlineParser.CODEBLOCK_REGEXPS - added:
const InlineParser.CODEBLOCK_TAGS - added:
const InlineParser.ESCAPING_CHARS - added:
const InlineParser.SCANNER_REGEXP - added:
const InlineParser.STANDALONE_TAGS - added:
const InlineParser.TAGS - added:
const InlineParser.TOKENS - added:
const InlineParser.WORD_PAIRS - added:
const InlineParser.WORD_REGEXPS - added:
const ToAnsi.ANSI_STYLE_CODES_OFF - added:
const ToAnsi.ANSI_STYLE_CODES_ON - added:
constructor Heading(_, _) - added:
constructor InlineParser(_) - added:
method Element.accept(_) - added:
method Element.pretty_print(_) - added:
method Formatter.apply_regexp_handling(_) - added:
method Formatter.handle_BOLD(_) - added:
method Formatter.handle_BOLD_WORD(_) - added:
method Formatter.handle_EM(_) - added:
method Formatter.handle_EM_WORD(_) - added:
method Formatter.handle_HARD_BREAK() - added:
method Formatter.handle_PLAIN_TEXT(_) - added:
method Formatter.handle_REGEXP_HANDLING_TEXT(_) - added:
method Formatter.handle_STRIKE(_) - added:
method Formatter.handle_TEXT(_) - added:
method Formatter.handle_TIDYLINK(_, _) - added:
method Formatter.handle_TT(_) - added:
method Formatter.handle_inline(_) - added:
method Formatter.traverse_inline_nodes(_) - added:
method Heading.==(_) - added:
method Heading.accept(_) - added:
method Heading.aref() - added:
method Heading.label(_ = …) - added:
method Heading.legacy_aref() - added:
method Heading.legacy_label(_ = …) - added:
method Heading.plain_html() - added:
method Heading.pretty_print(_) - added:
method InlineParser.current() - added:
method InlineParser.parse() - added:
method ToAnsi.add_text(_) - added:
method ToAnsi.apply_attributes(_) - added:
method ToAnsi.handle_inline(_) - added:
method ToBs.add_text(_) - added:
method ToBs.handle_inline(_) - added:
method ToHtmlCrossref.handle_regexp_CROSSREF(_) - added:
method ToHtmlCrossref.handle_regexp_HYPERLINK(_) - added:
method ToLabel.convert_legacy(_) - added:
method ToLabel.extract_plaintext(_) - added:
method ToLabel.handle_PLAIN_TEXT(_) - added:
method ToLabel.handle_REGEXP_HANDLING_TEXT(_) - added:
method ToLabel.handle_TT(_) - added:
method ToMarkdown.add_tag(_, _, _) - added:
method ToMarkdown.handle_BOLD(_) - added:
method ToMarkdown.handle_BOLD_WORD(_) - added:
method ToMarkdown.handle_EM(_) - added:
method ToMarkdown.handle_EM_WORD(_) - added:
method ToMarkdown.handle_HARD_BREAK() - added:
method ToMarkdown.handle_STRIKE(_) - added:
method ToMarkdown.handle_TIDYLINK(_, _) - added:
method ToMarkdown.handle_TT(_) - added:
method ToMarkdown.handle_tag(_, _, _) - added:
method ToRdoc.add_text(_) - added:
method ToRdoc.emit_inline(_) - added:
method ToRdoc.handle_BOLD(_) - added:
method ToRdoc.handle_BOLD_WORD(_) - added:
method ToRdoc.handle_EM(_) - added:
method ToRdoc.handle_EM_WORD(_) - added:
method ToRdoc.handle_HARD_BREAK() - added:
method ToRdoc.handle_PLAIN_TEXT(_) - added:
method ToRdoc.handle_REGEXP_HANDLING_TEXT(_) - added:
method ToRdoc.handle_STRIKE(_) - added:
method ToRdoc.handle_TIDYLINK(_, _) - added:
method ToRdoc.handle_TT(_) - added:
method ToRdoc.handle_inline(_, _ = …) - added:
method ToRdoc.off(_) - added:
method ToRdoc.on(_) - added:
method ToTest.handle_PLAIN_TEXT(_) - added:
method ToTest.handle_REGEXP_HANDLING_TEXT(_) - added:
property Heading.level: accessor - added:
property Heading.text: reader - added:
static method Heading.to_html() - added:
static method Heading.to_label()
- added:
property PrismRuby.in_proc_block: reader