The Readme must must be formatted as specified by README template : https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

shubham.prakash created an issue. See original summary.

shubham.prakash’s picture

Assigned: shubham.prakash » Unassigned
Status: Active » Needs review
FileSize
3.67 KB
joy29’s picture

Assigned: Unassigned » joy29
Status: Needs review » Needs work

Looks good, but readme.txt should README.txt

joy29’s picture

Status: Needs work » Needs review
FileSize
2.22 KB
shubham.prakash’s picture

Assigned: joy29 » Unassigned

The patch is #4 does not follow the documentation standards. Thanks.

alonaoneill’s picture

Status: Needs review » Needs work

I reviewed patch in comment #2
Everything looks good, but it needs some small changes:

  1. +++ b/Readme.txt
    @@ -1,14 +1,29 @@
     Allows you to make documents for tex. It uses a technology called Latex. LaTeX is a high-quality typesetting system. It includes features designed for the production of technical and scientific documentation. LaTeX is the de facto standard for the communication and publication of scientific documents. In other words "It can make your documents look incredible". Want to look the most professional you can, then use Latex.
    ...
     This module helps you use tokens to modify your content and download a tex file which can be converted to PDF.
    
    @@ -18,30 +33,35 @@ Latex for Drupal 8 requires the following:
    + * Install this module as you would normally install a contributed Drupal module.
    ...
    + * After compeleting the edits, click on "Submit" button to download the final tex file.
    

    Text should manually word-wrap within around 80 cols.

  2. +++ b/Readme.txt
    @@ -18,30 +33,35 @@ Latex for Drupal 8 requires the following:
    + * Go to admin/config/latex/settings or Configuration > Latex > Latex form. ¶
    

    Extra space should be removed in line 47!

shubham.prakash’s picture

Status: Needs work » Needs review
FileSize
4.19 KB

Thanks for the review, this patch should fix the issue.

alonaoneill’s picture

Status: Needs review » Reviewed & tested by the community

Reviewed the patch for spelling and grammar. Formatting aligns to Drupal documentation standards.
Everything looks good. Patch applied.
Marking as RTBCed.
Thank you for working on module!

gaurav.kapoor’s picture

Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.