While evaluating this module, while it has a readme, I noticed the readme could use some helpful links (permalinks as opposed to aliases) 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 |
|---|---|---|---|
| #2 | sticky_toolbar-readme-2981572-2.patch | 2.68 KB | volkswagenchick |
Comments
Comment #2
volkswagenchickI uploaded a patch that aligns the readme to Drupal documentation standards, thanks!!
Comment #3
alonaoneill commentedReviewed the patch for spelling and grammar. Formatting aligns to Drupal documentation standards. Everything looks good, but patch did not apply!
Marking as Need work.
Thank you for working on module!
Comment #4
volkswagenchickhhmm. i am unable to apply any of the patches I have made. Will re-approach this one next week.
Comment #5
volkswagenchickComment #6
dani3lr0se commentedThe patch applies cleanly locally for me. Simplytest.me doesn't like it for some reason, but formatting, spelling, grammar and readability all look good. Makes sense and easy to follow. It aligns with Drupal standards as well. Thanks for the patch @volkswagenchick. :)
Comment #8
bemarlanFixed in new release 8.x-1.1