- Issue created by @quietone
- 🇳🇿New Zealand quietone
In general I find wrapping code examples in quotes to make comments less readable
This is a challenging and I haven't found any on-line references on how to do this. Quotes are really for dialog but there isn't another option here to distinguished code from the text. Unless I am missing something, of course. And I must admit that after working on this issue for a while I like that the code is in quotes. It is just easier, for me, to comprehend the sentence.
Ideally, the inline comments should be explaining code and not providing examples. Examples are better placed in the docblock inside @code/@endcode tags. That way, api.d.o knows how to deal with the code sample. But, that doesn't cover all the things people want to do and certainly doesn't cover lines of code that are commented out.
There is always the option to add
phpcs:ignorelines to comments where agreement isn't reached. - 🇧🇪Belgium borisson_ Mechelen, 🇧🇪
I have gotten in the habit of using the markdown-like backticks when having to say that something is `code`. I think a lot of people will recognize this. Is that an option instead of using quotes?
We could even update the api.do parser to wrap those in a code-block as a next step?
The Needs Review Queue Bot → tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".
This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.
Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.
- 🇳🇿New Zealand quietone
And I found another instance where the semi-colon could be removed from a line of code in a sentence.
- 🇺🇸United States smustgrave
Going on a limb and believe feedback for this one has been addressed.
- 🇬🇧United Kingdom jonathan1055
I have made one suggestion in the MR to improve an
ignoreline, but still leaving this RTBC. Hopefully this can be merged soon, even though the sniff is not enabled in this MR it will be great to get the bulk of the warnings fixed. Then we can more easily see the difficult cases. Let's try to avoid too many more rebases as this touches 230 files :-) - 🇺🇸United States smustgrave
Believe all feedback on this one has been addressed or answered.
- 🇬🇧United Kingdom jonathan1055
Yes, this is still RTBC but the revert was not quite right, the quotes were swapped round, which could cause other unnecessary conflicts. I have made the suggestion in the MR to fix this.
- 🇳🇿New Zealand quietone
I don't know how I made such a basic mistake. I applied the suggestion.
- 🇬🇧United Kingdom jonathan1055
The swap was made when you were first adding the quotes around each character, and I did not notice that when I made the first suggestion to revert. Some editing programs make auto-corrections when typing one quote it inserts two, so it can be easy to make these types of unintended change :-)
Now the MR affects 319 files not 320 which confirms the revert. Still RTBC.
The Needs Review Queue Bot → tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".
This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.
Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.
The Needs Review Queue Bot → tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".
This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.
Consult the Drupal Contributor Guide → to find step-by-step guides for working with issues.
