Remove contents of hook_help() implementation, replace with link to project page [#2996604]

Problem/Motivation

The help text code is messy and has to be maintained separately from the project page on d.o, which has more or less the same content.

Proposed resolution

Remove the current content of the help page, and replace it with a link to the project page.

Remaining tasks

Remove the current content of the help page, and replace it with a link to the project page

User interface changes

Help page truncated and replaced with a link.

Comment	File	Size	Author
#9	gender.png	16.38 KB	nitin_lama
#2	gender_help_to_do_page-2996604-2.patch	12.92 KB	duaelfr

Issue fork gender-2996604

Show commands

Start within a Git clone of the project using the version control instructions.

Add & fetch this issue fork’s repository

Or, if you do not have SSH keys set up on git.drupalcode.org:

Add & fetch this issue fork’s repository

2996604-remove-contents-of changes, plain diff MR !2
Check out this branch for the first time

Check out existing branch, if you already have it locally

About issue forks

Comments

Comment #1

31 August 2018 at 21:00

alexdmccabe created an issue. See original summary.

Comment #2

duaelfr

he/him

French

Montpellier, France

commented 7 September 2018 at 15:56

Status:

Active

» Needs review

Status	File	Size
new	gender_help_to_do_page-2996604-2.patch	12.92 KB

I had a few minutes so here is a patch inspired from #2996607: Update README.md to link to project page

Comment #3

alexdmccabe

he/him

English

Orlando, FL, US / Seminole lands

commented 19 September 2018 at 22:19

I appreciate the patch, but in the future, please double-check the tags - this was intended to be a novice issue. I do realize that you posted the patch a week after the contrib day event itself, but working on the issue still could have been reserved for a novice.

Thanks!

Comment #4

alexdmccabe

he/him

English

Orlando, FL, US / Seminole lands

commented 19 September 2018 at 22:44

Status:

Needs review

» Needs work

That said, there's some work to be done.

https://www.drupal.org/docs/develop/standards/coding-standards#quotes

Translated strings where one can avoid escaping single quotes by enclosing the string in double quotes. One such string would be "He's a good person." It would be 'He\'s a good person.' with single quotes. Such escaping may not be handled properly by .pot file generators for text translation, and it's also somewhat awkward to read.

I'm pretty sure this also goes for escaping double quotes, so rather than

t("See the <a href=\":url\">gender

we could do

t('See the <a href=":url">gender

Comment #5

duaelfr

he/him

French

Montpellier, France

commented 20 September 2018 at 16:17

I won't answer about the noviceness of this issue because I'm not in a good mood and I don't want to expose you or myself to anger.

About the escaping issue, we have both simple (gender field module's project page and double quotes (<a href=":url">) in the translated string so I don't know how to handle this by the book. I'm not confident enough in english to rewrite the string but I'm sure someone else could.