search

php-pds / skeleton

Standard PHP package skeleton.
Creative Commons Attribution Share Alike 4.0 International
2.3k stars 167 forks source link

Clarify .md allowance #46

Closed dereuromark closed 6 years ago

dereuromark commented 6 years ago

It currently reads like it wasn't allowed to use .md files. This clarifies it. As per this repos root :)

pmjones commented 6 years ago

We don't feel that the very next sentence makes it clear that a filename extension is allowed? It reads, "It MAY have a lowercase filename extension indicating the file format."

dereuromark commented 6 years ago

that is just to clarify the * imo.

cxj commented 6 years ago

I think the original wording is good. It's more explicit than an assumed understanding of what (.*) could mean.

For example, Unix command line usage conventions would say that optional arguments or pieces of arguments should be enclosed in square brackets, so this would instead be indicated by [.*]. However, there are probably millions of software developers in the world who are not that familiar with decades-old Unix conventions, despite their widespread use in other contexts. Better to stick with whole English words as the original does with the following sentence, I think.