Update Range<T> XML docs #63
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Konard
requested changes
Dec 19, 2021
Konard
requested changes
Jan 4, 2022
присутствия -> включённости Co-authored-by: Konstantin Dyachenko <konard@me.com>
Co-authored-by: Konstantin Dyachenko <konard@me.com>
Co-authored-by: Konstantin Dyachenko <konard@me.com>
Co-authored-by: Konstantin Dyachenko <konard@me.com>
…nimum` and `maximum`
Konard
requested changes
Oct 19, 2022
| /// <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> |
There was a problem hiding this comment.
Suggested change
| /// <para>оле для чтения, которое представляет максимальное значение диапазона.</para> | |
| /// <para>Поле для чтения, которое представляет максимальное значение диапазона.</para> |
| /// <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> |
There was a problem hiding this comment.
Suggested change
| /// <para>Инициализирует новый экземпляр структуры <see cref="Range{T}"/> с одним указанным значением в качестве минимального и максимального значений.</para> | |
| /// <para>Инициализирует новый экземпляр структуры <see cref="Range{T}"/> с одним значением для <see cref="Minimum"/> и <see cref="Maximum"/>.</para> |
| /// </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> |
There was a problem hiding this comment.
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> |
| /// </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> |
There was a problem hiding this comment.
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> |
| @@ -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> | |||
There was a problem hiding this comment.
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> |
| /// <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> |
There was a problem hiding this comment.
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> |
| /// <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; |
There was a problem hiding this comment.
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.
| /// </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> |
There was a problem hiding this comment.
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> |
| [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> |
There was a problem hiding this comment.
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> |
| /// <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> |
There was a problem hiding this comment.
Suggested change
| /// <para>Определяет, содержится ли <paramref name="value"/> в текущей структуре <see cref="Range{T}"/>.</para> | |
| /// <para>Определяет, включено ли <paramref name="value"/> в этот экземпляр <see cref="Range{T}"/>.</para> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.