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 this module that it could use a little more documentation.
Patch to follow, thanks!

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

Assigned: volkswagenchick » Unassigned
Status: Needs work » Needs review
StatusFileSize
new4.02 KB

I have uploaded a patch with a README that contains a few more useful configuration and aligns better with Drupal.org documentation standards.

Thanks!

genevieveparker’s picture

Status: Needs review » Needs work
+++ b/README.txt
@@ -1,16 +1,95 @@
+       (Simple(with optional filter by bundle) is the default. Select how to

Looks like there is an extra open parenthesis here, or it is missing a a closed parenthesis? Also missing a space after "Simple"

volkswagenchick’s picture

Status: Needs work » Needs review
StatusFileSize
new4.03 KB

Thanks for the suggestions. I uploaded another patch.
Thanks

genevieveparker’s picture

Status: Needs review » Reviewed & tested by the community

looks good now :)

volkswagenchick’s picture

Any movement on this? I noticed today while looking at the project that the Readme could still use helpful links and configs. :)

minoroffense’s picture

Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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