According to Drupal standards, modules should include a useful README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu....
I noticed when evaluating and using this very useful module that the submodules are lacking documentation.
Patch to follow, thanks!

CommentFileSizeAuthor
#4 readmore_ajax-d8-add-readme-2920780-4.patch1.65 KBvolkswagenchick
#3 Screen Shot 2017-11-03 at 7.06.22 PM.png17.75 KBdhruveshdtripathi
#2 readmore_ajax-d8-add-useful-readme-2920780-2.patch1.66 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
readmore_ajax-d8-add-useful-readme-2920780-2.patch1.66 KB

Hi - I uploaded a patch with a useful README. thanks!

dhruveshdtripathi’s picture

dhruveshdtripathi CreditAttribution: dhruveshdtripathi at DevsAdda commented
Status: Needs review » Needs work
FileSize
Screen Shot 2017-11-03 at 7.06.22 PM.png17.75 KB

Got an error while applying the patch

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
readmore_ajax-d8-add-readme-2920780-4.patch1.65 KB

Lets try this again :)

dani3lr0se’s picture

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

Works well this time. I like it. Thanks for the patch. :)

dhruveshdtripathi’s picture

dhruveshdtripathi CreditAttribution: dhruveshdtripathi at DevsAdda commented

RTBC +1

abacaba’s picture

abacaba CreditAttribution: abacaba commented
Status: Reviewed & tested by the community » Fixed

Hi, @volkswagenchick thanks for your patch, I've pushed it

Status: Fixed » Closed (fixed)

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