- @sonal-gyanani opened merge request.
- Issue was unassigned.
- 🇮🇳India Sonal Gyanani
Created MR for the issue and fix some formatting issues according to Readme.md template → format.
Thanks - 🇪🇸Spain eduardo morales alberti Spain, 🇪🇺
Eduardo Morales Alberti → made their first commit to this issue’s fork.
- 🇪🇸Spain eduardo morales alberti Spain, 🇪🇺
I do not really like the commiters that have most of the issues changing the README.txt to README.md.
But I would like to improve the module documentation, so I will to commit some improvements here:- Now the module appears on the admin/index list, seems like if you do not add it to the menu, it does not appear on the list.
- Add menu link on the translation section
- The hook help was wrong and does not display anything
Before:
After (now as in other modules, the help information is extracted from the readme as markdown, that's why I change it here):
- Now the module appears on the admin/index list, seems like if you do not add it to the menu, it does not appear on the list.
- Status changed to Needs review
about 2 years ago 12:55pm 8 February 2023 - Status changed to Needs work
11 months ago 6:04pm 2 June 2024 - 🇳🇱Netherlands tess bakker
Nice work! Here is some feedback for MR !5
- The configure option isn't really a configure page as mentioned in #1786994-4: Add a "configure" link directly on "modules" list → , maybe some day if ✨ Add configuration so sites can customize which calls, files, and functions to ignore Needs work is committed?
- potx.module:28 , two lines earlier, an early return is placed. The Else-statement isn't needed.
- The description in potx.links.menu.yml is almost the same as the title, maybe something like: 'Get the translation from modules or themes.'?
- Readme.md: "The potx Drush command provided by the module. Examples:" should be a heading not a list item.
- I think it would be better to display a summary of the help or a hint to the Drush command feature on the actual potx page and an extended help on the help page. See `path_help()` for an example.
- 🇪🇸Spain eduardo morales alberti Spain, 🇪🇺
We created a different branch 3320327-documentation with the same commits, instead 8.x-1.x, updating the code.
Pending to apply tess bakker comments
- 🇪🇸Spain eduardo morales alberti Spain, 🇪🇺
eduardo morales alberti → changed the visibility of the branch 8.x-1.x to hidden.
- 🇪🇸Spain eduardo morales alberti Spain, 🇪🇺
1. The configure key should point to the settings route of the module as mentioned in the article https://drupalize.me/tutorial/overview-info-files-drupal-modules#configure
2. Done
3. Done
4. Done
5. We choose to display the readme on the help page to avoid duplicate information on the readme and the help page as other modules do.