Skip to content

Comments

Mcrypt/installation: mention "move" version nr#96

Closed
jrfnl wants to merge 1 commit intophp:masterfrom
jrfnl:feature/mcrypt-installation-mention-move-version
Closed

Mcrypt/installation: mention "move" version nr#96
jrfnl wants to merge 1 commit intophp:masterfrom
jrfnl:feature/mcrypt-installation-mention-move-version

Conversation

@jrfnl
Copy link
Contributor

@jrfnl jrfnl commented May 13, 2020

No description provided.

@cmb69
Copy link
Member

cmb69 commented May 13, 2020

Thanks! Applied as http://svn.php.net/viewvc?view=revision&revision=349868.

I think that you should apply for a php.net doc account. :)

@cmb69 cmb69 closed this May 13, 2020
@jrfnl jrfnl deleted the feature/mcrypt-installation-mention-move-version branch May 13, 2020 22:09
@jrfnl
Copy link
Contributor Author

jrfnl commented May 13, 2020

I think that you should apply for a php.net doc account. :)

@cmb69 I appreciate the whuffies ;-)

What would be the advantage of me having a php.net doc account ?
I'm generally used to working in a pull-review flow (i.e. don't merge your own PRs, always have someone review), so I'd still be sending in PRs in that case.
I also feel like I'm still very much finding my way in how the docs-setup works, so really do appreciate a second opinion for the time being.

Either way, I definitely appreciate the encouragement. This current round of PRs is the result of updates I'm making to PHPCompatibility and discrepancies I noticed because of that.

Going through the docs for this update round, I also noticed a lot of inconsistencies in page layouts, phrasing and extension page organisation.
Would PRs to make various docs more consistent/readable be welcome ?
Example of something I think might be useful: https://twitter.com/jrf_nl/status/1259877705698418689

@cmb69
Copy link
Member

cmb69 commented May 14, 2020

I'm generally used to working in a pull-review flow […]

A full pull-review workflow certainly has advantages, but obvious improvements/fixes (such as this PR or PR #98) could be committed directly; after all, that saves some time (especially regarding the SVN/Git dichotomy we currently have to live with, and also because CI does not (yet) produce rendered docs). Whenever there are doubts regarding a particular change, a PR (still) is fine.

This current round of PRs is the result of updates I'm making to PHPCompatibility and discrepancies I noticed because of that.

This is very much appreciated!

Would PRs to make various docs more consistent/readable be welcome ?

Generally, yes. Regarding the "table vs def list" question: in my opinion, tables are mostly bad for the purposes they're used in the current docs; in this particular case, a variablelist makes much more sense semantically, although the rendering/presentation should definitely be improved. But there are worse cases, e.g. tables which overflow on moderately sized browser windows, or even "presentational tables" which yield terrible diffs when they have to be amended.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants