doc-en
doc-en copied to clipboard
php
Wrap output string in `literal`
I think that we want strings like this wrapped in literal tags. Please let me know if this is not correct.
@TimWolla I hope you don't mind, I decided to add some more improvements to this PR. I think these are the last of these kinda of markup improvements I wanna make for the intro / tutorial.
We could probably add additional around acronyms - but I might leave that for now.
Couple of questions about contributing to the docs, while I have you here:
- Do you mind me grouping similar changes like this or would you prefer more atomic changes?
- Do we have a "style guide" for the docs, and if not, do you think one would be useful? I am happy to PR an small one with some of the small improvements I have been making - and we can expand on it into the future?
@timacdonald I'm afraid I'm really the wrong person to ask here. I'm not an expert with regard to the documentation. Other than reviewing the ext/random stuff which I maintain, I just try handle to obvious improvements so that the more knowledgeable folks can focus on the less obvious stuff.
@TimWolla I hope you don't mind, I decided to add some more improvements to this PR. I think these are the last of these kinda of markup improvements I wanna make for the intro / tutorial.
We could probably add additional around acronyms - but I might leave that for now.
Couple of questions about contributing to the docs, while I have you here:
1. Do you mind me grouping similar changes like this or would you prefer more atomic changes? 2. Do we have a "style guide" for the docs, and if not, do you think one would be useful? I am happy to PR an small one with some of the small improvements I have been making - and we can expand on it into the future?
There is a style guide on the doc website: http://doc.php.net/tutorial/style.php
The main thing with regards to changes is ideally for them to be atomic, but also not doing unnecessary changes that needlessly affect translations.
As such basic typos should be filed separately with a [skip-revcheck] commit so that a file is not marked as outdated for translations.
Code style is also a hot topic and shouldn't be changed just for the sake of it.
