According to Drupal standards, modules should include a useful README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu...

Patch to follow, thanks!!

CommentFileSizeAuthor
#4 interdiff-2861726-2-4.txt652 bytesvolkswagenchick
#4 views_infinite_scroll-add-readme-2861726-4.patch1.96 KBvolkswagenchick
#2 views_infinite_scroll-add-readme-2861726-2.patch1.97 KBvolkswagenchick
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented
Assigned: volkswagenchick » Unassigned
Status: Needs work » Needs review
FileSize
views_infinite_scroll-add-readme-2861726-2.patch1.97 KB

I uploaded a patch that includes a useful README.txt file. Thanks for the module!

riddhi.addweb’s picture

riddhi.addweb CreditAttribution: riddhi.addweb at AddWeb Solution Pvt. Ltd. commented
Status: Needs review » Needs work

@volkswagenchick, Thanks for your patch but there is a need for some minor changes in your patch.

1) Remove extra line spaces from each section, also remove extra 3 spaces below the "Supporting organization:" details

2)

+CONFIGURATION
+-------------

+7. Check the "Automatically Load Content" box if the functionality of automatically loading subsequent pages as the user scrolls is desired. 
+8. Select and amount of Items to display.  Apply changes.

Remove extra space before the "Apply changes."

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented
Status: Needs work » Needs review
FileSize
views_infinite_scroll-add-readme-2861726-4.patch1.96 KB
interdiff-2861726-2-4.txt652 bytes

Thank you for the review. I have an updated patch reflecting the suggested edits and included an interdiff for easy review.
Thanks!

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented

As per Drupal.org guidelines for READMEs, I kept the extra line breaks before headings. https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...
"Two lines prior to headings (except the first one)."

Thanks!

kristindev’s picture

kristindev CreditAttribution: kristindev at Hook 42 commented
Status: Needs review » Reviewed & tested by the community

This looks great and is ready to go. I also confirmed that two lines after each section is Drupal standards: https://www.drupal.org/node/2181737 "Two lines prior to headings (except the first one)."

K2

riddhi.addweb’s picture

riddhi.addweb CreditAttribution: riddhi.addweb at AddWeb Solution Pvt. Ltd. commented

@volkswagenchick, Apologies, I missed that point. Will take a learning note and contribute accordingly

Honza Pobořil’s picture

Honza Pobořil CreditAttribution: Honza Pobořil as a volunteer commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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