Update Range<T> XML docs #63

FreePhoenix888 · 2021-07-27T18:38:30Z

No description provided.

Konard

First part.

csharp/Platform.Ranges/Range[T].cs

присутствия -> включённости Co-authored-by: Konstantin Dyachenko <[email protected]>

Co-authored-by: Konstantin Dyachenko <[email protected]>

…t constructors

…="Range{T}"/>`

…nimum` and `maximum`

…eturns`

Konard

More changes required.

csharp/Platform.Ranges/Range[T].cs

Konard

Looks like we also have to change code here at the same time.

Konard · 2022-05-06T18:56:22Z

csharp/Platform.Ranges/Range[T].cs

-        /// <para>Returns maximum value of the range.</para>
-        /// <para>Возвращает максимальное значение диапазона.</para>
+        /// <para>A read-only field that represents a maximum value of the range.</para>
+        /// <para>оле для чтения, которое представляет максимальное значение диапазона.</para>


Suggested change

/// <para>оле для чтения, которое представляет максимальное значение диапазона.</para>

/// <para>Поле для чтения, которое представляет максимальное значение диапазона.</para>

Konard · 2022-10-19T18:58:30Z

csharp/Platform.Ranges/Range[T].cs

-        /// <para>Initializes a new instance of the Range class.</para>
-        /// <para>Инициализирует новый экземпляр класса Range.</para>
+        /// <para>Initializes a new instance of the <see cref="Range{T}"/> structure with a single specified value as minimum and maximum values.</para>
+        /// <para>Инициализирует новый экземпляр структуры <see cref="Range{T}"/> с одним указанным значением в качестве минимального и максимального значений.</para>


Suggested change

/// <para>Инициализирует новый экземпляр структуры <see cref="Range{T}"/> с одним указанным значением в качестве минимального и максимального значений.</para>

/// <para>Инициализирует новый экземпляр структуры <see cref="Range{T}"/> с одним значением для <see cref="Minimum"/> и <see cref="Maximum"/>.</para>

Konard · 2022-10-19T18:59:57Z

csharp/Platform.Ranges/Range[T].cs

        /// </summary>
        public readonly T Maximum;

        /// <summary>
-        /// <para>Initializes a new instance of the Range class.</para>
-        /// <para>Инициализирует новый экземпляр класса Range.</para>
+        /// <para>Initializes a new instance of the <see cref="Range{T}"/> structure with a single specified value as minimum and maximum values.</para>


Suggested change

/// <para>Initializes a new instance of the <see cref="Range{T}"/> structure with a single specified value as minimum and maximum values.</para>

/// <para>Initializes a new instance of the <see cref="Range{T}"/> structure with a single value for <see cref="Minimum"/> and <see cref="Maximum"/>.</para>

Konard · 2022-10-19T19:01:58Z

csharp/Platform.Ranges/Range[T].cs

        /// </summary>
-        /// <param name="minimumAndMaximum"><para>Single value for both Minimum and Maximum fields.</para><para>Одно значение для полей Minimum и Maximum.</para></param>
+        /// <param name="minimumAndMaximum">
+        /// <para>A single value for the both <see cref="Minimum"/> and <see cref="Maximum"/>.</para>


Suggested change

/// <para>A single value for the both <see cref="Minimum"/> and <see cref="Maximum"/>.</para>

/// <para>A single value for <see cref="Minimum"/> and <see cref="Maximum"/>.</para>

Konard · 2022-10-19T19:12:17Z

csharp/Platform.Ranges/Range[T].cs

@@ -43,12 +46,21 @@ public Range(T minimumAndMaximum)
        }

        /// <summary>
-        /// <para>Initializes a new instance of the Range class.</para>
-        /// <para>Инициализирует новый экземпляр класса Range.</para>
+        /// <para>Initializes a new instance of the <see cref="Range{T}"/> structure with the specified minimum and maximum values.</para>


Suggested change

/// <para>Initializes a new instance of the <see cref="Range{T}"/> structure with the specified minimum and maximum values.</para>

/// <para>Initializes a new instance of the <see cref="Range{T}"/> structure using specified <paramref name="minimum"/> and <paramref name="maximum"/>.</para>

Konard · 2022-10-19T19:17:18Z

csharp/Platform.Ranges/Range[T].cs

+        /// <para>Значение для проверки его присутствия в структуре <see cref="Range{T}"/>.</para>
+        /// </param>
+        /// <returns>
+        /// <para>A <see cref="Boolean"/> value that determines whether the <see cref="Range{T}"/> struct contains the <paramref name="value"/>.</para>


Suggested change

/// <para>A <see cref="Boolean"/> value that determines whether the <see cref="Range{T}"/> struct contains the <paramref name="value"/>.</para>

/// <para>A <see cref="Boolean"/> value that determines whether this <see cref="Range{T}"/> instance includes the <paramref name="value"/>.</para>

Konard · 2022-10-19T19:20:05Z

csharp/Platform.Ranges/Range[T].cs

+        /// <returns>
+        /// <para>A <see cref="Boolean"/> value that determines whether the <see cref="Range{T}"/> struct contains the <paramref name="value"/>.</para>
+        /// <para>Значение типа <see cref="Boolean"/>, определяющее, содержится ли <paramref name="value"/> в структуре <see cref="Range{T}"/>.</para>
+        /// </returns>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public bool Contains(T value) => _comparer.Compare(Minimum, value) <= 0 && _comparer.Compare(Maximum, value) >= 0;


Suggested change

public bool Contains(T value) => _comparer.Compare(Minimum, value) <= 0 && _comparer.Compare(Maximum, value) >= 0;

public bool Includes(T value) => _comparer.Compare(Minimum, value) <= 0 && _comparer.Compare(Maximum, value) >= 0;

Note: this a breaking change. We should also ensure to use include instead of contain for Ranges everywhere. This is because word include is used with Range much more frequently.

Konard · 2022-10-19T19:27:33Z

csharp/Platform.Ranges/Range[T].cs

+        /// </param>
+        /// <returns>
+        /// <para>A <see cref="Boolean"/> value that determines whether the <see cref="Range{T}"/> struct contains the <paramref name="value"/>.</para>
+        /// <para>Значение типа <see cref="Boolean"/>, определяющее, содержится ли <paramref name="value"/> в структуре <see cref="Range{T}"/>.</para>


Suggested change

/// <para>Значение типа <see cref="Boolean"/>, определяющее, содержится ли <paramref name="value"/> в структуре <see cref="Range{T}"/>.</para>

/// <para>Значение типа <see cref="Boolean"/>, определяющее, включено ли <paramref name="value"/> в этот экземпляр <see cref="Range{T}"/>.</para>

Konard · 2022-10-19T19:28:59Z

csharp/Platform.Ranges/Range[T].cs

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public override string ToString() => $"[{Minimum}..{Maximum}]";

        /// <summary>
-        /// <para>Determines if the provided value is inside the range.</para>
-        /// <para>Определяет, находится ли указанное значение внутри диапазона.</para>
+        /// <para>Determines whether the current <see cref="Range{T}"/> struct contains the <paramref name="value"/>.</para>


Suggested change

/// <para>Determines whether the current <see cref="Range{T}"/> struct contains the <paramref name="value"/>.</para>

/// <para>Determines whether this <see cref="Range{T}"/> instance includes <paramref name="value"/>.</para>

Konard · 2022-10-19T19:29:35Z

csharp/Platform.Ranges/Range[T].cs

-        /// <para>Determines if the provided value is inside the range.</para>
-        /// <para>Определяет, находится ли указанное значение внутри диапазона.</para>
+        /// <para>Determines whether the current <see cref="Range{T}"/> struct contains the <paramref name="value"/>.</para>
+        /// <para>Определяет, содержится ли <paramref name="value"/> в текущей структуре <see cref="Range{T}"/>.</para>


Suggested change

/// <para>Определяет, содержится ли <paramref name="value"/> в текущей структуре <see cref="Range{T}"/>.</para>

/// <para>Определяет, включено ли <paramref name="value"/> в этот экземпляр <see cref="Range{T}"/>.</para>

FreePhoenix888 added 24 commits July 27, 2021 22:58

Update constructors XML Docs

8497b8d

Update fields XML Docs

5401b08

Update articles

3a8b556

Use see tag in constructor docs

054913f

Format

bbeb2a4

Update Contains() XML Docs

9224186

Format XML Docs

759f82c

Update XML Docs - Use <see/>

804be38

Update XML Docs

15f9fdd

Update Equals() XML Docs

36544b4

Update GetHashCode() XML Docs

16b5e53

Update == XML Docs

4642105

Update != XML Docs

b054a25

Update contructors XML DOcs

6aa7824

Update see cref Range to Range<T>

7f1067f

Update contructors XML Docs

d8fdd27

Remove redundant summary tag

87a41c8

Update ToString() XML Docs

732489f

Update XML Docs

2418a04

Format XML Docs

05549d9

Update XML Docs

404cf94

Format XML Docs

020005c

Update XML Docs

72f5d90

Format XML Docs

2aac032

FreePhoenix888 mentioned this pull request Jul 28, 2021

upgrade comments of class constructors #47

Open

FreePhoenix888 linked an issue Jul 28, 2021 that may be closed by this pull request

upgrade comments of class constructors #47

Open

Konard requested changes Jul 28, 2021

View reviewed changes

FreePhoenix888 added 3 commits July 29, 2021 14:44

Update XML Docs

860e5ae

Update XML Docs - operators

dfa8f88

Update XML Docs - Remove redundant articles

06e5167

FreePhoenix888 added 4 commits November 10, 2021 16:11

Remove word допустимое from XML documentation

d55bc6b

Remove space at the line end

6e4f156

Update XML Documentation

fb6b70b

Update XML DocumentationNN

efba57b

Konard requested changes Dec 19, 2021

View reviewed changes

csharp/Platform.Ranges/Range[T].cs Outdated Show resolved Hide resolved

csharp/Platform.Ranges/Range[T].cs Outdated Show resolved Hide resolved

csharp/Platform.Ranges/Range[T].cs Outdated Show resolved Hide resolved

Konard requested changes Jan 4, 2022

View reviewed changes

FreePhoenix888 and others added 14 commits January 5, 2022 12:42

Update constructors summary

88402d0

Update XML Docs

82ced6c

присутствия -> включённости Co-authored-by: Konstantin Dyachenko <[email protected]>

Remove with the double

f3494be

объекта -> из

bcc6009

c -> со

5984e26

Co-authored-by: Konstantin Dyachenko <[email protected]>

равны ли -> равны ли диапазоны

17d4b9b

Co-authored-by: Konstantin Dyachenko <[email protected]>

left and right -> left and rigth ranges

a0acbcf

Co-authored-by: Konstantin Dyachenko <[email protected]>

не равны ли left и right -> не равны ли диапазоны left и right

97c1ac5

Co-authored-by: Konstantin Dyachenko <[email protected]>

Use (struct|структура) instead of (object|instance) everywhere bu…

462115b

…t constructors

Update XML Docs: Provides for fields

267be45

Update XML Docs: текущего диапазона -> `текущей структуры <see cref…

616f186

…="Range{T}"/>`

Update XML Docs: (value|значением) -> (values|значениями) for `mi…

363d1ae

…nimum` and `maximum`

Update XML Docs: for both -> for the both

da464ac

Update XML Docs: add (ranges|диапазоны) before left and rigth in `r…

d76da06

…eturns`

FreePhoenix888 requested a review from Konard January 5, 2022 07:18

FreePhoenix888 changed the base branch from master to main March 27, 2022 07:14

FreePhoenix888 mentioned this pull request Mar 27, 2022

Change organization pull requests base branch from master to main linksplatform/Data.Doublets#340

Closed

Konard requested changes Mar 30, 2022

View reviewed changes

FreePhoenix888 and others added 5 commits March 30, 2022 23:20

Update Minimum and Maximum docs

d40319f

Update Range constructor docs

b79e91d

Update docs

0b79544

Update docs

070f055

Two more spaces.

050241c

Konard requested changes Oct 19, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Range<T> XML docs #63

Update Range<T> XML docs #63

FreePhoenix888 commented Jul 27, 2021

Konard left a comment

Konard left a comment

Konard left a comment

Konard May 6, 2022

Konard Oct 19, 2022

Konard Oct 19, 2022

Konard Oct 19, 2022

Konard Oct 19, 2022

Konard Oct 19, 2022

Konard Oct 19, 2022

Konard Oct 19, 2022

Konard Oct 19, 2022

Konard Oct 19, 2022

	/// <para>оле для чтения, которое представляет максимальное значение диапазона.</para>
	/// <para>Поле для чтения, которое представляет максимальное значение диапазона.</para>

	/// <para>Инициализирует новый экземпляр структуры <see cref="Range{T}"/> с одним указанным значением в качестве минимального и максимального значений.</para>
	/// <para>Инициализирует новый экземпляр структуры <see cref="Range{T}"/> с одним значением для <see cref="Minimum"/> и <see cref="Maximum"/>.</para>

	/// <para>Initializes a new instance of the <see cref="Range{T}"/> structure with a single specified value as minimum and maximum values.</para>
	/// <para>Initializes a new instance of the <see cref="Range{T}"/> structure with a single value for <see cref="Minimum"/> and <see cref="Maximum"/>.</para>

	/// <para>A single value for the both <see cref="Minimum"/> and <see cref="Maximum"/>.</para>
	/// <para>A single value for <see cref="Minimum"/> and <see cref="Maximum"/>.</para>

	/// <para>A <see cref="Boolean"/> value that determines whether the <see cref="Range{T}"/> struct contains the <paramref name="value"/>.</para>
	/// <para>A <see cref="Boolean"/> value that determines whether this <see cref="Range{T}"/> instance includes the <paramref name="value"/>.</para>

	public bool Contains(T value) => _comparer.Compare(Minimum, value) <= 0 && _comparer.Compare(Maximum, value) >= 0;
	public bool Includes(T value) => _comparer.Compare(Minimum, value) <= 0 && _comparer.Compare(Maximum, value) >= 0;

	/// <para>Значение типа <see cref="Boolean"/>, определяющее, содержится ли <paramref name="value"/> в структуре <see cref="Range{T}"/>.</para>
	/// <para>Значение типа <see cref="Boolean"/>, определяющее, включено ли <paramref name="value"/> в этот экземпляр <see cref="Range{T}"/>.</para>

	/// <para>Determines whether the current <see cref="Range{T}"/> struct contains the <paramref name="value"/>.</para>
	/// <para>Determines whether this <see cref="Range{T}"/> instance includes <paramref name="value"/>.</para>

	/// <para>Определяет, содержится ли <paramref name="value"/> в текущей структуре <see cref="Range{T}"/>.</para>
	/// <para>Определяет, включено ли <paramref name="value"/> в этот экземпляр <see cref="Range{T}"/>.</para>

Update Range<T> XML docs #63

Are you sure you want to change the base?

Update Range<T> XML docs #63

Conversation

FreePhoenix888 commented Jul 27, 2021

Konard left a comment

Choose a reason for hiding this comment

Konard left a comment

Choose a reason for hiding this comment

Konard left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment