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
#9 location_generate-add-readme-2868823-9.patch1.83 KBvolkswagenchick
#9 interdiff-2868823-7-9.txt859 bytesvolkswagenchick
#7 interdiff-2868823-6-7.txt1.52 KBvolkswagenchick
#7 location_generate-add-readme-2868823-7.patch1.83 KBvolkswagenchick
#6 location_generate-add-readme-2868823-6.patch1.84 KBvolkswagenchick
#2 location_generate-add-readme-2868823-2.patch3.59 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
FileSize
location_generate-add-readme-2868823-2.patch3.59 KB

Thanks for this module. I uploaded a patch with a useful README for the location_generate submodule.

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

Thankyou ddrozdik for the formatting guidance!

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented
Assigned: volkswagenchick » Unassigned
loopduplicate’s picture

loopduplicate
she/her
Location Burning Token, California
CreditAttribution: loopduplicate at Hook 42 commented 
  1. +++ b/contrib/location_generate/README.txt
@@ -0,0 +1,52 @@
+(https://www.drupal.org/project/location)package, allows users to bulk assign random latitude and longitudes to nodes.

    Needs a space between location)package 

  2. +++ b/contrib/location_generate/README.txt
@@ -0,0 +1,52 @@
diff --git a/location_fax-README.txt b/location_fax-README.txt

    Looks like the README for location fax got mixed up into this patch.

Otherwise, looks good.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented
FileSize
location_generate-add-readme-2868823-6.patch1.84 KB

Ooops! Here's a patch with a useful README for just the location_generate submodule!

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented
FileSize
location_generate-add-readme-2868823-7.patch1.83 KB
interdiff-2868823-6-7.txt1.52 KB

I fixed the last patch to eliminate some extra spaces at line breaks and included an interdiff to view the changes.

Thanks!

loopduplicate’s picture

loopduplicate
she/her
Location Burning Token, California
CreditAttribution: loopduplicate at Hook 42 commented 
+++ b/contrib/location_generate/README.txt
@@ -0,0 +1,59 @@
+(https://www.drupal.org/project/location)package, allows users to bulk assign

Probably could use a space between the end parenthesis and the word "package".

Otherwise, looks great :)

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
CreditAttribution: volkswagenchick at Hook 42 commented
FileSize
interdiff-2868823-7-9.txt859 bytes
location_generate-add-readme-2868823-9.patch1.83 KB

Thanks for the review! I uploaded a new patch with spacing and punctuation fixes along with an interdiff reflecting the changes

loopduplicate’s picture

loopduplicate
she/her
Location Burning Token, California
CreditAttribution: loopduplicate at Hook 42 commented
Status: Needs review » Reviewed & tested by the community