- 🇬🇧United Kingdom jonathan1055
I have updated the issue summary with the improvements from comments #8 and #10.
The next thing to do will be to use the new Coding Standards issue template being trialed on #3387167: Add an issue template for the Coding Standards project → . This contains the new process for getting standards agreed and documentation pages updated.
- 🇳🇿New Zealand quietone New Zealand
@jonathan1055, thanks for updating the IS.
I haven't found 'all-caps' in a dictionary so am suggesting a change. Also, I don't think the extension includes the '.' nor do I think the examples need to be given twice. So, how about this
Documentation files should either be in plain text with the file name extension "txt", or be valid Markdown syntax with the file name extension "md".
The base file name should be all upper case and the extension itself should be all-lowercase.
Examples: README.md, README.txt, INSTALL.md, TODO.txt, CHANGELOG.txt.
- Status changed to Needs work
11 months ago 10:33pm 10 October 2023 - 🇦🇺Australia alex.skrypnyk Melbourne
I have to agree with #13 and disagree with #14, sorry. I do not see a point to linking to Wikipedia and then, later, re-linking to D.O - this feels like following a process for the sake of the process. Majority of developers already know what Markdown is. If we want it to be formatted in a specific way according to Drupal standards, then we have a page for it in D.O. Although that page does not have much right now, it will be filled separately outside of this issue, which is not about the Markdown format but about the file naming conventions.
I'm putting this issue back to Needs work to discuss this more.
- Assigned to Mohd Sahzad
- Issue was unassigned.
- 🇳🇿New Zealand quietone New Zealand
Updated to use the new coding standards issue template.
Are there changes to be made to "The Module documentation guidelines"?
- 🇺🇸United States bkline@rksystems.com Virginia
#23 None of which I'm aware. What did you have in mind? This issue assumes that the implication in the module documentation guidelines (that the use of markdown for such documentation is appropriate) is correct.
I had no idea when I pointed out the discrepancy five years ago that it would turn out to be so controversial. 😉