Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
While evaluating this module, while it has a readme, - I noticed the readme could use some helpful links and configurations. Also, the formatting does not align to Drupal standards for documentation. There should be a clear table of contents and lines should be hard wrapped at 80 characters for better accessibility.
According to Drupal standards, modules should include a useful README.file.
https://www.drupal.org/docs/develop/documenting-your-project/module-docu....
https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...
Patch to follow, thanks!
Comment | File | Size | Author |
---|---|---|---|
#5 | ajax_comments-README-fix-3063795-5.patch | 6 KB | alonaoneill |
| |||
#2 | ajax_comments-README-fix-3063795-2.patch | 6 KB | alonaoneill |
|
Comments
Comment #2
alonaoneill CreditAttribution: alonaoneill at Hook 42 commentedComment #3
alonaoneill CreditAttribution: alonaoneill at Hook 42 commentedComment #4
JQTNguyen CreditAttribution: JQTNguyen at Hook 42 commentedPlease consider the following feedback, which includes changes to conform with Drupal.org documentation standards at https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...
Text should manually word-wrap within around 80 cols.
Typo: change to "Troubleshooting".
Text should manually word-wrap within around 80 cols.
Comment #5
alonaoneill CreditAttribution: alonaoneill at Hook 42 commentedI made changes.
Thanks!
Comment #6
JQTNguyen CreditAttribution: JQTNguyen at Hook 42 commentedChanges look good, and patch applies smoothly on Simplytest.me. Marking RTBC.
Comment #8
qzmenkoCommitted and pushed. Thanks!
Comment #9
qzmenko