Skip to content

[DOC] Revision of Paragraphs section #1417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[DOC] Revision of Paragraphs section #1417

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions doc/rdoc/markup_reference.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,14 +124,8 @@
#
# You'll love it.
#
# A paragraph may contain nested blocks, including:
# A paragraph may contain only one type of nested block:
#
# - {Verbatim text blocks}[rdoc-ref:RDoc::MarkupReference@Verbatim+Text+Blocks].
# - {Code blocks}[rdoc-ref:RDoc::MarkupReference@Code+Blocks].
# - {Block quotes}[rdoc-ref:RDoc::MarkupReference@Block+Quotes].
# - {Lists}[rdoc-ref:RDoc::MarkupReference@Lists].
# - {Headings}[rdoc-ref:RDoc::MarkupReference@Headings].
# - {Horizontal rules}[rdoc-ref:RDoc::MarkupReference@Horizontal+Rules].
# - {Text Markup}[rdoc-ref:RDoc:MarkupReference@Text+Markup].
Comment on lines +127 to 129
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO a list with one bullet point shouldn't be a list.

I also don't know what the point of this change is, what is considered a "nested block"? The "Text Markup" section just talks about how to format the text with bold, italics, and monofont. Is that even considered a block or just formatting?

At any rate, I think we either keep the original (and maybe reword it) or just remove all of this completely.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've sometimes used a 1-item list to make treatments parallel, which I've thought helpful. (The other sections put nestings in lists.)

About your questions: I've asked them myself:

#
# ==== Verbatim Text Blocks
Expand Down
Loading