kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

[ruby/rdoc] Add block quotes (https://github.com/ruby/rdoc/pull/907)

Browse source 
Also adjusts which blocks may be nested.

dde1860441
This commit is contained in:
Burdette Lamar 2022-07-29 09:40:12 -05:00 • committed by git
parent 62849b3379
commit f78e46d404
1 changed files with 57 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

66
doc/rdoc/markup_reference.rb
View file

@ -57,6 +57,7 @@ require 'rdoc'
# - {Paragraphs}[rdoc-ref:RDoc::MarkupReference@Paragraphs]. # - {Paragraphs}[rdoc-ref:RDoc::MarkupReference@Paragraphs].
# - {Verbatim text blocks}[rdoc-ref:RDoc::MarkupReference@Verbatim+Text+Blocks]. # - {Verbatim text blocks}[rdoc-ref:RDoc::MarkupReference@Verbatim+Text+Blocks].
# - {Code blocks}[rdoc-ref:RDoc::MarkupReference@Code+Blocks]. # - {Code blocks}[rdoc-ref:RDoc::MarkupReference@Code+Blocks].
# - {Block quotes}[rdoc-ref:RDoc::MarkupReference@Block+Quotes].
# - {Bullet lists}[rdoc-ref:RDoc::MarkupReference@Bullet+Lists]. # - {Bullet lists}[rdoc-ref:RDoc::MarkupReference@Bullet+Lists].
# - {Numbered lists}[rdoc-ref:RDoc::MarkupReference@Numbered+Lists]. # - {Numbered lists}[rdoc-ref:RDoc::MarkupReference@Numbered+Lists].
# - {Lettered lists}[rdoc-ref:RDoc::MarkupReference@Lettered+Lists]. # - {Lettered lists}[rdoc-ref:RDoc::MarkupReference@Lettered+Lists].
@ -99,7 +100,10 @@ require 'rdoc'
# #
# - Verbatim text blocks. # - Verbatim text blocks.
# - Code blocks. # - Code blocks.
# - Block quotes.
# - Lists of any type. # - Lists of any type.
# - Headings.
# - Horizontal rules.
# #
# ==== Verbatim Text Blocks # ==== Verbatim Text Blocks
# #
@ -169,6 +173,49 @@ require 'rdoc'
# Pro tip: If your indented Ruby code does not get highlighted, # Pro tip: If your indented Ruby code does not get highlighted,
# it may contain a syntax error. # it may contain a syntax error.
# #
# ==== Block Quotes
#
# You can use the characters <tt>>>></tt> (unindented),
# followed by indented text, to treat the text
# as a {block quote}[https://en.wikipedia.org/wiki/Block_quotation]:
#
# Example input:
#
# >>>
# Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer
# commodo quam iaculis massa posuere, dictum fringilla justo pulvinar.
# Quisque turpis erat, pharetra eu dui at, sollicitudin accumsan nulla.
#
# Aenean congue ligula eu ligula molestie, eu pellentesque purus
# faucibus. In id leo non ligula condimentum lobortis. Duis vestibulum,
# diam in pellentesque aliquet, mi tellus placerat sapien, id euismod
# purus magna ut tortor.
#
# Rendered HTML:
#
# >>>
# Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer
# commodo quam iaculis massa posuere, dictum fringilla justo pulvinar.
# Quisque turpis erat, pharetra eu dui at, sollicitudin accumsan nulla.
#
# Aenean congue ligula eu ligula molestie, eu pellentesque purus
# faucibus. In id leo non ligula condimentum lobortis. Duis vestibulum,
# diam in pellentesque aliquet, mi tellus placerat sapien, id euismod
# purus magna ut tortor.
#
# A block quote may contain nested blocks, including:
#
# - Other block quotes.
# - Paragraphs.
# - Verbatim text blocks.
# - Code blocks.
# - Lists of any type.
# - Headings.
# - Horizontal rules.
#
# Note that, unlike verbatim text, single newlines are not honored,
# but that a double newline begins a new paragraph in the block quote.
#
# ==== Lists # ==== Lists
# #
# Each type of list item is marked by a special beginning: # Each type of list item is marked by a special beginning:
@ -190,6 +237,16 @@ require 'rdoc'
# A list item may be continued on additional lines that are aligned # A list item may be continued on additional lines that are aligned
# with the first line. See examples below. # with the first line. See examples below.
# #
# A list item may contain nested blocks, including:
#
# - Other lists of any type.
# - Paragraphs.
# - Verbatim text blocks.
# - Code blocks.
# - Block quotes.
# - Headings.
# - Horizontal rules.
#
# ===== Bullet Lists # ===== Bullet Lists
# #
# A bullet list item begins with a hyphen or asterisk. # A bullet list item begins with a hyphen or asterisk.
@ -291,15 +348,6 @@ require 'rdoc'
# [bar baz] Yet another. # [bar baz] Yet another.
# bam:: Last one. # bam:: Last one.
# #
# ===== Blocks Nested in Lists
#
# A list item may contain nested blocks, including:
#
# - Paragraphs.
# - Verbatim text blocks.
# - Code blocks.
# - Other lists of any type.
#
# ==== Headings # ==== Headings
# #
# A heading begins with up to six equal-signs, followed by heading text. # A heading begins with up to six equal-signs, followed by heading text.