Pending patch incoming to address the following issues seen in README.txt

  • Miscellaneous spelling/formatting issues
  • When referencing module name "Paragraphs" is the proper name (not "Paragraph")
  • "Paragraphs" should only be capitalized when referring to the module by name
  • All section headers should be written uppercase for consistency

Thanks

Issue fork paragraphs-3079782

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

bygeoffthompson created an issue. See original summary.

bygeoffthompson’s picture

Patch attached.

bygeoffthompson’s picture

Assigned: bygeoffthompson » Unassigned
Status: Active » Needs review
Webbeh’s picture

StatusFileSize
new6.51 KB
new9.32 KB

Re-rolled #2 with the latest version, and cleaned up the README to comply with the README template best-practices.

Interdiff + patch attached.

lucienchalom’s picture

Assigned: Unassigned » lucienchalom

I will reroll the patch and review it.

lucienchalom’s picture

Status: Needs review » Needs work
StatusFileSize
new13.56 KB

I re-rolled and found conflicts on the paragraph about widgets.
also, requirements needs an update.
moving too needs work, but keep it assigned to me

lucienchalom’s picture

Assigned: lucienchalom » Unassigned
Status: Needs work » Needs review
StatusFileSize
new6.33 KB

Added info on Requirements section, moving back to needs review

Status: Needs review » Needs work

The last submitted patch, 7: 3079782-7.patch, failed testing. View results

marcusvsouza’s picture

Hi, your readme it's almost 100% correct, you just need to put this # in the beginning of your titles and subtitles just like below

#The largest heading
## The second largest heading
###### The smallest heading

Considering the errors in test are not in the paragraphs module i think you can do this fix in the patch and move on the issue.

lucienchalom’s picture

Assigned: Unassigned » lucienchalom

I will fix it, thank you!

lucienchalom’s picture

Assigned: lucienchalom » Unassigned
Status: Needs work » Needs review
StatusFileSize
new7.92 KB

To make this changes, I made the README a markdown file.
I hope this is correct?
Thank you for the review.

Status: Needs review » Needs work

The last submitted patch, 11: 3079782-markdown.patch, failed testing. View results

marcusvsouza’s picture

Status: Needs work » Needs review
marcusvsouza’s picture

Status: Needs review » Reviewed & tested by the community

The patch in the comment #11 contain all the information required and fill the requisites of the documentation.