Although this module does have an existing README, it lacks some tips on functionality and configuration.

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

README to follow. Thanks!

CommentFileSizeAuthor
#5 interdiff_2-5.txt3.22 KBdhruveshdtripathi
#5 readme_needed-2849557-5.patch2.93 KBdhruveshdtripathi
#2 i18nviews-add-readme-2849557-2.patch2.85 KBvolkswagenchick

Comments

volkswagenchick created an issue. See original summary.

volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Assigned: volkswagenchick » Unassigned
Issue summary: View changes
Status: Needs work » Needs review
StatusFileSize
new i18nviews-add-readme-2849557-2.patch2.85 KB

Uploaded a patch with a README that contains some useful tips for configuration and functionality. THANKS!

loopduplicate’s picture

loopduplicate commented
Issue summary: View changes
Status: Needs review » Reviewed & tested by the community

Looks good to me :)

damienmckenna’s picture

damienmckenna
Location TN, USA
commented
Status: Reviewed & tested by the community » Needs work

Needs a minor tweak to wrap at 80 characters.

dhruveshdtripathi’s picture

dhruveshdtripathi commented
Status: Needs work » Needs review
StatusFileSize
new readme_needed-2849557-5.patch2.93 KB
new interdiff_2-5.txt3.22 KB

Three minor changes made:

  • Numbered lists indented 4 spaces.
  • Bulleted lists indented 1 space.
  • Text manually word-wrapped within around 80 cols.
volkswagenchick’s picture

volkswagenchick
she/her
Primary language English
Location San Francisco Bay Area
commented
Status: Needs review » Reviewed & tested by the community

Thanks for reviewing this patch! When I initially wrote this patch I was not fluent in documentation standards, thanks for your patience.

Patch #5 looks good, marked RTBC.