From a882a03bef2d72701918152307fe29ccd6dbf308 Mon Sep 17 00:00:00 2001 From: Gina Peter Banyard Date: Tue, 28 May 2024 00:51:39 +0100 Subject: [PATCH 1/4] Proposal for Enum markup --- reference/random/random.intervalboundary.xml | 97 ++++++++++++++++++++ 1 file changed, 97 insertions(+) create mode 100644 reference/random/random.intervalboundary.xml diff --git a/reference/random/random.intervalboundary.xml b/reference/random/random.intervalboundary.xml new file mode 100644 index 000000000000..54258df17110 --- /dev/null +++ b/reference/random/random.intervalboundary.xml @@ -0,0 +1,97 @@ + + + IntervalBoundary + IntervalBoundary + + +
+ &reftitle.intro; + + Intro + +
+ +
+ + &reftitle.classsynopsis; + + + IntervalBoundary + + + + ClosedOpen + + + Description of enum case. + + + + + ClosedClosed + + + Description of enum case. + + + + + OpenClosed + + + Description of enum case. + + + + + OpenOpen + + + Description of enum case. + + + + +
+ + + From 0fcc62a2468d6e2f24d5868e0011a1d77e01ed0d Mon Sep 17 00:00:00 2001 From: Gina Peter Banyard Date: Sun, 17 Nov 2024 04:20:31 +0000 Subject: [PATCH 2/4] Add descriptions --- reference/random/book.xml | 1 + reference/random/random.intervalboundary.xml | 56 ++++++-------------- 2 files changed, 18 insertions(+), 39 deletions(-) diff --git a/reference/random/book.xml b/reference/random/book.xml index 3a4d4aa44db5..7ebac831c95c 100644 --- a/reference/random/book.xml +++ b/reference/random/book.xml @@ -16,6 +16,7 @@ &reference.random.reference; &reference.random.random.randomizer; + &reference.random.random.intervalboundary; &reference.random.random.engine; &reference.random.random.cryptosafeengine; diff --git a/reference/random/random.intervalboundary.xml b/reference/random/random.intervalboundary.xml index 54258df17110..336f934a5e7a 100644 --- a/reference/random/random.intervalboundary.xml +++ b/reference/random/random.intervalboundary.xml @@ -1,73 +1,51 @@ - - IntervalBoundary - IntervalBoundary + + Random\IntervalBoundary + Random\IntervalBoundary -
+
&reftitle.intro; - Intro + The Random\IntervalBoundary cases determines if the + boundary values can be returned or not by + Random\Randomizer::getFloat.
-
- - &reftitle.classsynopsis; +
+ &reftitle.enumsynopsis; - IntervalBoundary - - + Random\IntervalBoundary + ClosedOpen - - Description of enum case. + The min value may be returned. + However, the max value will never be returned. ClosedClosed - - Description of enum case. + Both the min and max value may be returned. OpenClosed - - Description of enum case. + The max value may be returned. + However, the min value will never be returned. OpenOpen - - Description of enum case. + Neither the min or max will ever be returned. From 48086f7bb8d840df56d9dd0ed9e46cac575ce606 Mon Sep 17 00:00:00 2001 From: Gina Peter Banyard Date: Wed, 20 Nov 2024 16:45:46 +0000 Subject: [PATCH 3/4] Update reference/random/random.intervalboundary.xml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Tim Düsterhus --- reference/random/random.intervalboundary.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/random/random.intervalboundary.xml b/reference/random/random.intervalboundary.xml index 336f934a5e7a..5c3afea97256 100644 --- a/reference/random/random.intervalboundary.xml +++ b/reference/random/random.intervalboundary.xml @@ -1,6 +1,6 @@ - Random\IntervalBoundary + The Random\IntervalBoundary Enum Random\IntervalBoundary From 9e1e9975b043ac0761b3eb6eba6f3137ae2c21c7 Mon Sep 17 00:00:00 2001 From: Gina Peter Banyard Date: Wed, 20 Nov 2024 16:49:11 +0000 Subject: [PATCH 4/4] Review + version.xml --- reference/random/random.intervalboundary.xml | 22 ++++++++++++-------- reference/random/versions.xml | 3 +++ 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/reference/random/random.intervalboundary.xml b/reference/random/random.intervalboundary.xml index 5c3afea97256..f7b273256ad8 100644 --- a/reference/random/random.intervalboundary.xml +++ b/reference/random/random.intervalboundary.xml @@ -7,9 +7,9 @@
&reftitle.intro; - The Random\IntervalBoundary cases determines if the - boundary values can be returned or not by - Random\Randomizer::getFloat. + The Random\IntervalBoundary enum specifies + whether an interval includes the boundary values within the set of values + lying in the interval.
@@ -22,30 +22,34 @@ ClosedOpen - The min value may be returned. - However, the max value will never be returned. + A left-open interval. + The lower boundary is included in the interval, + the upper boundary is not. ClosedClosed - Both the min and max value may be returned. + A closed interval. + Both boundary values are included in the interval. OpenClosed - The max value may be returned. - However, the min value will never be returned. + A right-open interval. + The upper boundary is included in the interval, + the lower boundary is not. OpenOpen - Neither the min or max will ever be returned. + An open interval. + Neither boundary value is included in the interval. diff --git a/reference/random/versions.xml b/reference/random/versions.xml index eee9c8aadf65..65455f70e35b 100644 --- a/reference/random/versions.xml +++ b/reference/random/versions.xml @@ -95,6 +95,9 @@ + + +