Re: a few coding standards

> Hello all! > > Just want to confirm that the following are true as I don't > believe these have been made official [yet]: > > a) No ending period in the reftitle agree here > b) No ending period in the see also Why not? "See also echo and print." The ending period makes sense to me! > c) Only part of docs wider than 78 characters is > methodsynopsis This is already agreeded... At least with the VI comments, you can't write longer lines > d) New examples use ' not " wherever possible (this is > old since PEAR coding standards describe it but few > do it, not sure why) We already refer that examples should follow the PEAR coding standards. > e) All new (and eventually old) docs will use the new > upcoming 'refsect style' What is this upcoming style? Can you explain me, please? Maybe I wans't here when you've discussed that. > Regarding (a), it's a little strange when a reftitle has > multiple sentences, or commas, as it means only partial > punctuation is used when we leave off the ending period. > Should we live with that? Most are not this way so it > should be fine. Also, many times these titles aren't > even complete sentences. Reftitles should be short! Just a smal descriptive phrase about the function. So, they shouldn't have any ponctuation, IHMO. Nuno