[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] [doc-en] master: random: Improve short descriptions for methods (#2007)
From: Tim_Düsterhus_via_GitHub <noreply () php ! net>
Date: 2022-11-15 16:33:31
Message-ID: b23alxxk7DM43i48LAiejcvIWzY8N8241wMr1xxGwUw () main ! php ! net
[Download RAW message or body]
Author: Tim Düsterhus (TimWolla)
Committer: GitHub (web-flow)
Pusher: TimWolla
Date: 2022-11-15T17:22:51+01:00
Commit: https://github.com/php/doc-en/commit/215fd48515e0793760b2079fff8380c629e11b3f
Raw diff: https://github.com/php/doc-en/commit/215fd48515e0793760b2079fff8380c629e11b3f.diff
random: Improve short descriptions for methods (#2007)
* random: Unify the short description for random_(bytes|int) with Randomizer
* random: Use imperative mood for short descriptions of engine methods
This is for consistency. The PHP manual appears to use imperative mood for the
majority of functions and all of Randomizer's functions already too.
* random: Shorten the short description for random_int and Randomizer::getInt()
Changed paths:
M reference/random/functions/random-bytes.xml
M reference/random/functions/random-int.xml
M reference/random/random/engine/mt19937/generate.xml
M reference/random/random/engine/pcgoneseq128xslrr64/generate.xml
M reference/random/random/engine/pcgoneseq128xslrr64/jump.xml
M reference/random/random/engine/secure/generate.xml
M reference/random/random/engine/xoshiro256starstar/generate.xml
M reference/random/random/engine/xoshiro256starstar/jump.xml
M reference/random/random/engine/xoshiro256starstar/jumplong.xml
M reference/random/random/randomizer/getint.xml
Diff:
diff --git a/reference/random/functions/random-bytes.xml \
b/reference/random/functions/random-bytes.xml index 21c6b1e0da3..22780f01e93 100644
--- a/reference/random/functions/random-bytes.xml
+++ b/reference/random/functions/random-bytes.xml
@@ -3,7 +3,7 @@
<refentry xml:id="function.random-bytes" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv>
<refname>random_bytes</refname>
- <refpurpose>Generates cryptographically secure pseudo-random bytes</refpurpose>
+ <refpurpose>Get cryptographically secure random bytes</refpurpose>
</refnamediv>
<refsect1 role="description"><!-- {{{ -->
diff --git a/reference/random/functions/random-int.xml \
b/reference/random/functions/random-int.xml index 22b0842ceae..5c0f01b7271 100644
--- a/reference/random/functions/random-int.xml
+++ b/reference/random/functions/random-int.xml
@@ -4,7 +4,7 @@
<refentry xml:id="function.random-int" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv>
<refname>random_int</refname>
- <refpurpose>Generates cryptographically secure pseudo-random integers</refpurpose>
+ <refpurpose>Get a cryptographically secure, uniformly selected \
integer</refpurpose> </refnamediv>
<refsect1 role="description"><!-- {{{ -->
diff --git a/reference/random/random/engine/mt19937/generate.xml \
b/reference/random/random/engine/mt19937/generate.xml index ba800bfce63..2987798b1d2 \
100644
--- a/reference/random/random/engine/mt19937/generate.xml
+++ b/reference/random/random/engine/mt19937/generate.xml
@@ -2,7 +2,7 @@
<refentry xml:id="random-engine-mt19937.generate" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>Random\Engine\Mt19937::generate</refname>
- <refpurpose>Generates 32 bits of randomness</refpurpose>
+ <refpurpose>Generate 32 bits of randomness</refpurpose>
</refnamediv>
<refsect1 role="description">
diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/generate.xml \
b/reference/random/random/engine/pcgoneseq128xslrr64/generate.xml index \
1d3654b852b..d0be9aae573 100644
--- a/reference/random/random/engine/pcgoneseq128xslrr64/generate.xml
+++ b/reference/random/random/engine/pcgoneseq128xslrr64/generate.xml
@@ -2,7 +2,7 @@
<refentry xml:id="random-engine-pcgoneseq128xslrr64.generate" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>Random\Engine\PcgOneseq128XslRr64::generate</refname>
- <refpurpose>Generates 64 bits of randomness</refpurpose>
+ <refpurpose>Generate 64 bits of randomness</refpurpose>
</refnamediv>
<refsect1 role="description">
diff --git a/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml \
b/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml index \
f9b8fc879e6..165880ffeac 100644
--- a/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml
+++ b/reference/random/random/engine/pcgoneseq128xslrr64/jump.xml
@@ -2,7 +2,7 @@
<refentry xml:id="random-engine-pcgoneseq128xslrr64.jump" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>Random\Engine\PcgOneseq128XslRr64::jump</refname>
- <refpurpose>Efficiently moves the engine ahead multiple steps</refpurpose>
+ <refpurpose>Efficiently move the engine ahead multiple steps</refpurpose>
</refnamediv>
<refsect1 role="description">
diff --git a/reference/random/random/engine/secure/generate.xml \
b/reference/random/random/engine/secure/generate.xml index 600fc64069e..059f1b21d2d \
100644
--- a/reference/random/random/engine/secure/generate.xml
+++ b/reference/random/random/engine/secure/generate.xml
@@ -2,7 +2,7 @@
<refentry xml:id="random-engine-secure.generate" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>Random\Engine\Secure::generate</refname>
- <refpurpose>Generates cryptographically secure randomness</refpurpose>
+ <refpurpose>Generate cryptographically secure randomness</refpurpose>
</refnamediv>
<refsect1 role="description">
diff --git a/reference/random/random/engine/xoshiro256starstar/generate.xml \
b/reference/random/random/engine/xoshiro256starstar/generate.xml index \
1a3c9664e77..5217583a1f0 100644
--- a/reference/random/random/engine/xoshiro256starstar/generate.xml
+++ b/reference/random/random/engine/xoshiro256starstar/generate.xml
@@ -2,7 +2,7 @@
<refentry xml:id="random-engine-xoshiro256starstar.generate" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>Random\Engine\Xoshiro256StarStar::generate</refname>
- <refpurpose>Generates 64 bits of randomness</refpurpose>
+ <refpurpose>Generate 64 bits of randomness</refpurpose>
</refnamediv>
<refsect1 role="description">
diff --git a/reference/random/random/engine/xoshiro256starstar/jump.xml \
b/reference/random/random/engine/xoshiro256starstar/jump.xml index \
b03c04d44eb..17d1826b024 100644
--- a/reference/random/random/engine/xoshiro256starstar/jump.xml
+++ b/reference/random/random/engine/xoshiro256starstar/jump.xml
@@ -2,7 +2,7 @@
<refentry xml:id="random-engine-xoshiro256starstar.jump" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>Random\Engine\Xoshiro256StarStar::jump</refname>
- <refpurpose>Efficiently moves the engine ahead by 2^128 steps</refpurpose>
+ <refpurpose>Efficiently move the engine ahead by 2^128 steps</refpurpose>
</refnamediv>
<refsect1 role="description">
diff --git a/reference/random/random/engine/xoshiro256starstar/jumplong.xml \
b/reference/random/random/engine/xoshiro256starstar/jumplong.xml index \
e432f092bc2..5d78593dcfd 100644
--- a/reference/random/random/engine/xoshiro256starstar/jumplong.xml
+++ b/reference/random/random/engine/xoshiro256starstar/jumplong.xml
@@ -2,7 +2,7 @@
<refentry xml:id="random-engine-xoshiro256starstar.jumplong" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>Random\Engine\Xoshiro256StarStar::jumpLong</refname>
- <refpurpose>Efficiently moves the engine ahead by 2^192 steps</refpurpose>
+ <refpurpose>Efficiently move the engine ahead by 2^192 steps</refpurpose>
</refnamediv>
<refsect1 role="description">
diff --git a/reference/random/random/randomizer/getint.xml \
b/reference/random/random/randomizer/getint.xml index 5649380a5ae..2da0ac63f28 100644
--- a/reference/random/random/randomizer/getint.xml
+++ b/reference/random/random/randomizer/getint.xml
@@ -2,7 +2,7 @@
<refentry xml:id="random-randomizer.getint" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv>
<refname>Random\Randomizer::getInt</refname>
- <refpurpose>Get a uniformly selected integer from a closed interval</refpurpose>
+ <refpurpose>Get a uniformly selected integer</refpurpose>
</refnamediv>
<refsect1 role="description">
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic