ruby / ruby/rdoc

Can a paragraph contain blocks?

Open
#1,414 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Ruby
Stars
930
Forks
465
Avg merge
3d 10h
Merged PRs (30d)
27

Description

In the markup reference, I've written that a paragraph may contain other blocks. Is this true? Would it be better to say that a paragraph may contain only embedded text markup?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the markup reference mentioned in the issue and check how it describes paragraph contents and block elements. Confirm the markup rules, then revise the paragraph description to distinguish blocks from embedded text markup; the documentation should clearly state what a paragraph may contain.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.