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.

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!

CommentFileSizeAuthor
#2 academic_applications-README-3001526-2.patch4.29 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
Status: Active » Needs review
StatusFileSize
new academic_applications-README-3001526-2.patch4.29 KB

I uploaded a patch that re-formats the readme to better align with Drupal standards, thanks

The numbering was off in the config section.

cilefen’s picture

cilefen commented
Status: Needs review » Fixed

Thank you @volkswagenchick!

I fixed two things on commit:

  1. There were too many spaces before the ordered items, which in markdown is interpreted as a code block.
  2. A markdown hyperlink with syntax []() was broken by a line break.

There is a trailing whitespace that I just noticed that I'll fix.

Status: Fixed » Closed (fixed)

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