AllSegmentsWalkerBase new documentation #137

kiritozevs · 2021-08-26T12:28:55Z

No description provided.

FreePhoenix888 · 2021-08-27T13:14:40Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

-    /// Represents the all segments walker base.
-    /// </para>
-    /// <para></para>
+    /// <para>All Segment sWalker Base or Class with WalkAll method to walk through all segments in the dictionary.</para>


Provides the base class from which the classes that represent all segments walker are derived. This is an abstract class.

FreePhoenix888 · 2021-08-27T13:16:32Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

    /// </summary>
    public abstract class AllSegmentsWalkerBase
    {
        /// <summary>
        /// <para>
-        /// The default minimum string segment length.
+        /// Default value for the field _minimumStringSegmentLength object of the same class. Assigned when the constructor is called.


Gets default minimum string segment length.
Use Возвращает in Russian version.

FreePhoenix888 · 2021-08-27T13:17:35Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-    /// Represents the all segments walker base.
-    /// </para>
-    /// <para></para>
+    /// <para>All Segment sWalker Base or Class with WalkAll method to walk through all segments in the dictionary.</para>


Provides the base class from which the classes that represent all segments walker are derived. This is an abstract class.

FreePhoenix888 · 2021-08-27T13:20:24Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// </para>
-        /// <para></para>
+         /// <summary>
+        /// <para>Calls the segment constructor, initializes 3 fields on the segment instance</para>


Initializes a new instance of the <see cref="Segment"/> class, using the <paramref name="elements"/> list, <paramref name="offset"/> of the segment and its <paramref name="length" />.
Source

FreePhoenix888 · 2021-08-28T05:51:34Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

-        /// Дефолтное значение для поля _minimumStringSegmentLength этого же класса, используемого в методе  WalkAll. Присваивается при вызове конструктора.
-        /// </para>
+        /// <para>Gets default minimum string segment length.</para> 
+        /// <para>Возвращает дефолтную минимальную длинну строки мегмента.</para> 


Use по умолчанию instead of дефолтная

Suggested change

/// <para>Возвращает дефолтную минимальную длинну строки мегмента.</para>

/// <para>Равняется минимально допустимой длиной сегмента.</para>

@uselessgoddess then Возвращает минимально допустимую длину сегмента.

Sorry, i'm Russian

FreePhoenix888 · 2021-08-28T05:54:57Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// <para>Calls the segment constructor, initializes 3 fields on the segment instance</para>
-        /// <para>Вызывает конструктор сегмента, инициализирует 3 поля у экземпляра сегмента.</para>
+        /// <summary>
+        /// <para>Initializes a new instance of the <see cref="Segment"/> class, using the <paramref name="base"/> list of the segment, Offset relative to the list<paramref name="offset"/> and The segment's length <paramref name="length" />.</para>


Things like "the base parameter is the a of the segment", "the offset parameter is an offset relative to the list", "the length parameter is an length of the segment" specified in param tags, so we should follow the programming rule DRY.
Initializes a new instance of the <see cref="Segment"/> class, using the <paramref name="base"/>, <paramref name="offset"/>, <paramref name="length"/>.

FreePhoenix888 · 2021-08-28T05:57:18Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// <returns>
-        /// <para>An instance of the Segment class.</para> <para>Экземпляр класса Segment<T>.</para>
-        /// </returns>
+        /// <param name="base"><para>The reference to the original list containing the elements of this segment.</para><para>Ссылка на исходный список в котором находятся элементы этого сегмента.</para></param>


A reference instead of The reference because of it is the parameter, and reference passed as argument is not known in this context. We have to get ANY reference passed as base argument, not specific reference.
Add line terminator between </para> and <para>

FreePhoenix888 · 2021-08-28T05:57:56Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// <para>An instance of the Segment class.</para> <para>Экземпляр класса Segment<T>.</para>
-        /// </returns>
+        /// <param name="base"><para>The reference to the original list containing the elements of this segment.</para><para>Ссылка на исходный список в котором находятся элементы этого сегмента.</para></param>
+        /// <param name="offset"><para>The offset relative to the <paramref name="base"/> list from which the segment starts.</para><para>Смещение относительно списка <paramref name="base"/>, с которого начинается сегмент.</para></param>


The same as above

Write easier

FreePhoenix888 · 2021-08-28T05:58:14Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// </returns>
+        /// <param name="base"><para>The reference to the original list containing the elements of this segment.</para><para>Ссылка на исходный список в котором находятся элементы этого сегмента.</para></param>
+        /// <param name="offset"><para>The offset relative to the <paramref name="base"/> list from which the segment starts.</para><para>Смещение относительно списка <paramref name="base"/>, с которого начинается сегмент.</para></param>
+        /// <param name="length"><para>The segment's length.</para><para>Длина сегмента.</para></param>


The same as above

Why The does not translate to my lovely language?

uselessgoddess · 2021-08-28T06:16:24Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

-    /// </para>
-    /// <para></para>
+    /// <para>Provides the base class from which the classes that represent all segments walker are derived. This is an abstract class.</para>
+    /// <para>Предоставляет базовый класс, от которого наследуются классы, реализующие AllSegmentsWalkerBase. Это абстрактный класс.</para>


Lol. Review of the Russian text in English language

Suggested change

/// <para>Предоставляет базовый класс, от которого наследуются классы, реализующие AllSegmentsWalkerBase. Это абстрактный класс.</para>

/// <para>Базовый абстрактный класс для всех [вставьте тут синоним слова "волкеров"]</para>

Use smaller doc-comments
No extra information is needed

The subjective thinking of a C++fan

uselessgoddess · 2021-08-28T06:22:28Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

+        /// <para>Instance of the Segment class<T></para>
+        /// <para>Экземпляр класса Segment</para>


Use more full comments

Use a see tag for the Segment, by the way the see tag can refer to Generic class, therefore do not remove , use {T} in the see tag

FreePhoenix888 · 2021-08-28T13:10:22Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

-        /// The default minimum string segment length.
-        /// </para>
-        /// <para></para>
+        /// <para>Gets default minimum string segment length.</para> 


Suggested change

/// <para>Gets default minimum string segment length.</para>

/// <para>Gets a default minimum length of string segment.</para>

More readable, and a added.

Hold my tea

FreePhoenix888 · 2021-08-28T13:12:26Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// <para>The length.</para>
-        /// <para></para>
-        /// </param>
+        /// <param name="elements"><para>A reference to the original list containing the elements of this segment.</para>


Suggested change

/// <param name="elements"><para>A reference to the original list containing the elements of this segment.</para>

/// <param name="elements">

<para>A reference to the original list containing the elements of this segment.</para>

Hmm...

Suggested change

/// <param name="elements"><para>A reference to the original list containing the elements of this segment.</para>

/// <param name="elements">

/// <para>A reference to the original list containing the elements of this segment.</para>

FreePhoenix888 · 2021-08-28T13:12:43Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// <para></para>
-        /// </param>
+        /// <param name="elements"><para>A reference to the original list containing the elements of this segment.</para>
+        /// <para>Ссылка на исходный список в котором находятся элементы этого сегмента.</para></param>


Suggested change

/// <para>Ссылка на исходный список в котором находятся элементы этого сегмента.</para></param>

/// <para>Ссылка на исходный список в котором находятся элементы этого сегмента.</para>

</param>

FreePhoenix888 · 2021-08-28T13:13:22Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// </param>
+        /// <param name="elements"><para>A reference to the original list containing the elements of this segment.</para>
+        /// <para>Ссылка на исходный список в котором находятся элементы этого сегмента.</para></param>
+        /// <param name="offset"><para>The offset relative to the <paramref name="elements"/> list from which the segment starts.</para>


Suggested change

/// <param name="offset"><para>The offset relative to the <paramref name="elements"/> list from which the segment starts.</para>

/// <param name="offset">

<para>An offset relative to the <paramref name="elements"/> list from which the segment starts.</para>

FreePhoenix888 · 2021-08-28T13:13:53Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

+        /// <param name="elements"><para>A reference to the original list containing the elements of this segment.</para>
+        /// <para>Ссылка на исходный список в котором находятся элементы этого сегмента.</para></param>
+        /// <param name="offset"><para>The offset relative to the <paramref name="elements"/> list from which the segment starts.</para>
+        /// <para>Смещение относительно списка <paramref name="elements"/>, с которого начинается сегмент.</para></param>


Suggested change

/// <para>Смещение относительно списка <paramref name="elements"/>, с которого начинается сегмент.</para></param>

/// <para>Смещение относительно списка <paramref name="elements"/>, с которого начинается сегмент.</para>

</param>

FreePhoenix888 · 2021-08-28T13:14:24Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

+        /// <para>Ссылка на исходный список в котором находятся элементы этого сегмента.</para></param>
+        /// <param name="offset"><para>The offset relative to the <paramref name="elements"/> list from which the segment starts.</para>
+        /// <para>Смещение относительно списка <paramref name="elements"/>, с которого начинается сегмент.</para></param>
+        /// <param name="length"><para>The segment's length.</para>


Suggested change

/// <param name="length"><para>The segment's length.</para>

/// <param name="length">

<para>A length of the segment.</para>

FreePhoenix888 · 2021-08-28T13:14:32Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

+        /// <param name="offset"><para>The offset relative to the <paramref name="elements"/> list from which the segment starts.</para>
+        /// <para>Смещение относительно списка <paramref name="elements"/>, с которого начинается сегмент.</para></param>
+        /// <param name="length"><para>The segment's length.</para>
+        /// <para>Длина сегмента.</para></param>


Suggested change

/// <para>Длина сегмента.</para></param>

/// <para>Длина сегмента.</para>

</param>

FreePhoenix888 · 2021-08-28T13:15:04Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// <para>A segment of t</para>
-        /// <para></para>
-        /// </returns>
+        /// <para>Gets instance of the <see cref="Segment"/> class<T></para>


Suggested change

/// <para>Gets instance of the <see cref="Segment"/> class<T></para>

/// <para>Initiailizes a new instance of the <see cref="Segment"/> class<T></para>

FreePhoenix888 · 2021-08-28T13:15:16Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// <para></para>
-        /// </returns>
+        /// <para>Gets instance of the <see cref="Segment"/> class<T></para>
+        /// <para>Возвращает экземпляр класса <see cref="Segment"/></para>


Suggested change

/// <para>Возвращает экземпляр класса <see cref="Segment"/></para>

/// <para>Инициализирует новый экземпляр класса <see cref="Segment"/></para>

Это делает только конструктор Придумайте что-то новенькое

uselessgoddess

Comments are ignored by compiler

FreePhoenix888 · 2021-08-28T15:04:08Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

@@ -9,7 +9,7 @@ namespace Platform.Collections.Segments.Walkers
    public abstract class AllSegmentsWalkerBase
    {
        /// <summary>
-        /// <para>Gets default minimum string segment length.</para> 
+        /// <para>>Gets a default minimum length of string segment.</para> 


Suggested change

/// <para>>Gets a default minimum length of string segment.</para>

/// <para>Gets a default minimum length of the string segment.</para>

FreePhoenix888 · 2021-08-28T15:04:50Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

+        /// <para>Ссылка на исходный список в котором находятся элементы этого сегмента.</para>
+        /// </param>
+        /// <param name="offset">
+        /// <para>The offset relative to the <paramref name="elements"/> list from which the segment starts.</para>


Suggested change

/// <para>The offset relative to the <paramref name="elements"/> list from which the segment starts.</para>

/// <para>An offset relative to the <paramref name="elements"/> list from which the segment starts.</para>

FreePhoenix888 · 2021-08-28T15:05:10Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

+        /// <para>Смещение относительно списка <paramref name="elements"/>, с которого начинается сегмент.</para>
+        /// </param>
+        /// <param name="length">
+        /// <para>The segment's length.</para>


Suggested change

/// <para>The segment's length.</para>

/// <para>A segment's length.</para>

FreePhoenix888 · 2021-08-28T15:05:42Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

        /// <returns>
-        /// <para>Gets instance of the <see cref="Segment"/> class<T></para>
-        /// <para>Возвращает экземпляр класса <see cref="Segment"/></para>
+        /// <para>instance of the <see cref="Segment"/> class<T></para>


Suggested change

/// <para>instance of the <see cref="Segment"/> class<T></para>

/// <para>An instance of the <see cref="Segment{T}"/> class.</para>

FreePhoenix888 · 2021-08-28T15:06:13Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// <para>Gets instance of the <see cref="Segment"/> class<T></para>
-        /// <para>Возвращает экземпляр класса <see cref="Segment"/></para>
+        /// <para>instance of the <see cref="Segment"/> class<T></para>
+        /// <para>экземпляр класса <see cref="Segment"/></para>


Suggested change

/// <para>экземпляр класса <see cref="Segment"/></para>

/// <para>Экземпляр класса <see cref="Segment{T}"/>.</para>

uselessgoddess

It sounds strange in Russian

uselessgoddess · 2021-08-29T08:09:09Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

-    /// </para>
-    /// <para></para>
+    /// <para>Represents the base abstract class for walkers on all elements.</para>
+    /// <para>Представляет базовый абстрактный класс для проходчиков по всем элементам.</para>


Suggested change

/// <para>Представляет базовый абстрактный класс для проходчиков по всем элементам.</para>

/// <para>Базовый абстрактный класс для проходчиков по всем элементам.</para>

uselessgoddess · 2021-08-29T08:09:48Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

-        /// </para>
-        /// <para></para>
+        /// <para>Gets a default minimum length of the string segment.</para> 
+        /// <para>Возвращает минимально допустимую длину сегмента.</para> 


Suggested change

/// <para>Возвращает минимально допустимую длину сегмента.</para>

/// <para>Минимально допустимая длина сегмента.</para>

Поле только для чтения, которое представляет ...
... минимальную длину сегмента последовательности по умолчанию.

uselessgoddess · 2021-08-29T08:10:04Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-    /// </para>
-    /// <para></para>
+    /// <para>Represents the base abstract class for walkers on all elements.</para>
+    /// <para>Представляет базовый абстрактный класс для проходчиков по всем элементам.</para>


Suggested change

/// <para>Представляет базовый абстрактный класс для проходчиков по всем элементам.</para>

/// <para>Базовый абстрактный класс для проходчиков по всем элементам.</para>

uselessgoddess · 2021-08-29T08:10:58Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// </para>
-        /// <para></para>
+        /// <para>Initializes a new instance of the <see cref="Segment"/> class.</para>
+        /// <para>Инициализирует новый экземпляр класса <see cref="Segment"/></para>


Suggested change

/// <para>Инициализирует новый экземпляр класса <see cref="Segment"/></para>

/// <para>Создаёт новый экземпляр класса <see cref="Segment"/></para>

Create --> Создавать (порождать)

uselessgoddess · 2021-08-29T08:11:19Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// <para>The elements.</para>
-        /// <para></para>
+        /// <para>A reference to the original list containing the elements of this segment.</para>
+        /// <para>Ссылка на исходный список в котором находятся элементы этого сегмента.</para>


Suggested change

/// <para>Ссылка на исходный список в котором находятся элементы этого сегмента.</para>

/// <para>Исходный список в котором находятся элементы этого сегмента.</para>

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

uselessgoddess · 2021-08-29T19:16:37Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// </returns>
+        /// <para>An instance of the <see cref="Segment{T}"/> class.</para>
+        /// <para>Экземпляр класса <see cref="Segment{T}"/> .</para>
+        ///</returns>


Suggested change

///</returns>

/// </returns>

You also have extra spaces on lines 32 and 33

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

TwinkmrMask

Pay attention to possible similar errors

TwinkmrMask · 2021-08-29T21:11:53Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

@@ -31,7 +31,7 @@ public abstract class AllSegmentsWalkerBase<T> : AllSegmentsWalkerBase<T, Segmen
        /// <returns>
        /// <para>An instance of the <see cref="Segment{T}"/> class.</para>
        /// <para>Экземпляр класса <see cref="Segment{T}"/> .</para>


An extra space before the dot, as well as on line 17

Also an extra space on line 21

Remove extra space

FreePhoenix888 · 2021-08-30T06:28:58Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// <para>The elements.</para>
-        /// <para></para>
+        /// <para>List of elements.</para>
+        /// <para>Список  элементов.</para>


Remove extra space

FreePhoenix888 · 2021-08-30T06:29:43Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

        /// </param>
        /// <param name="offset">
-        /// <para>The offset.</para>
-        /// <para></para>
+        /// <para>An offset relative to the <paramref name="elements"/> list from which the segment starts.</para>


Suggested change

/// <para>An offset relative to the <paramref name="elements"/> list from which the segment starts.</para>

/// <para>An offset relative to the start of the<paramref name="elements"/> from which the segment starts.</para>

Konard

It was close.

Konard · 2021-09-03T19:33:56Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

-    /// </para>
-    /// <para></para>
+    /// <para>Represents the base abstract class for walkers on all elements.</para>
+    /// <para>Представляет базовый класс для проходчиков по всем элементам.</para>


... по всем возможным сегментам последовательности.

Konard · 2021-09-03T19:37:30Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

-        /// </para>
-        /// <para></para>
+        /// <para>Gets a default minimum length of the string segment.</para> 
+        /// <para>Возвращает минимально допустимую длину сегмента.</para> 


Поле только для чтения, которое представляет ...
... минимальную длину сегмента последовательности по умолчанию.

Konard · 2021-09-03T19:39:45Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

-        /// The default minimum string segment length.
-        /// </para>
-        /// <para></para>
+        /// <para>Gets a default minimum length of the string segment.</para> 


A read-only field that represents ...
... the default minimum sequence segment length.

Konard · 2021-09-04T17:26:18Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

-    /// Represents the all segments walker base.
-    /// </para>
-    /// <para></para>
+    /// <para>Represents the base class for sinkers for all possible segments of the sequence.</para>


Suggested change

/// <para>Represents the base class for sinkers for all possible segments of the sequence.</para>

/// <para>Represents a base class for walkers through all possible segments of a sequence.</para>

Konard · 2021-09-04T17:29:00Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-        /// </para>
-        /// <para></para>
+        /// <para>Initializes a new instance of the <see cref="Segment"/> class.</para>
+        /// <para>Инициализирует новый экземпляр класса <see cref="Segment"/> .</para>


This is not a constructor, but a virtual method.

Suggested change

/// <para>Инициализирует новый экземпляр класса <see cref="Segment"/> .</para>

/// <para>Создаёт новый экземпляр класса <see cref="Segment{T}"/> на основе последовательности <paramref name="elements"/>.</para>

Konard · 2021-09-04T17:29:26Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

        /// </summary>
        /// <param name="elements">
-        /// <para>The elements.</para>
-        /// <para></para>
+        /// <para>List of elements.</para>


Suggested change

/// <para>List of elements.</para>

/// <para>A list of elements.</para>

Konard · 2021-09-04T17:30:46Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

        /// </param>
        /// <param name="offset">
-        /// <para>The offset.</para>
-        /// <para></para>
+        /// <para>An offset relative to the start of the <paramref name="elements"/> from which the segment starts.</para>


Suggested change

/// <para>An offset relative to the start of the <paramref name="elements"/> from which the segment starts.</para>

/// <para>An offset relative to the <paramref name="elements"/> sequence from which the segment starts.</para>

uselessgoddess

Compiler ignores comments

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

FreePhoenix888 · 2021-09-08T20:05:08Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

@@ -31,7 +31,7 @@ public abstract class AllSegmentsWalkerBase<T> : AllSegmentsWalkerBase<T, Segmen
        /// <returns>
        /// <para>An instance of the <see cref="Segment{T}"/> class.</para>
        /// <para>Экземпляр класса <see cref="Segment{T}"/> .</para>


Remove extra space

FreePhoenix888 · 2021-09-08T20:06:21Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

-        /// The default minimum string segment length.
-        /// </para>
-        /// <para></para>
+        /// <para>A read-only field that represents the minimum length of the default sequence segment.</para> 


Suggested change

/// <para>A read-only field that represents the minimum length of the default sequence segment.</para>

/// <para>A read-only field that represents the default minimum length of the sequence segment.</para>

FreePhoenix888 · 2021-09-11T15:31:28Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

    public abstract class AllSegmentsWalkerBase<T> : AllSegmentsWalkerBase<T, Segment<T>>
    {
        /// <summary>
        /// <para>Create a new instance of the <see cref="Segment"/> class based on <paramref name="elements"/> sequence.</para>
-        /// <para>Создаёт  новый экземпляр класса <see cref="Segment"/> на основе последовательности <paramref name="elements"/>.</para>
+        /// <para>Создаёт новый экземпляр класса <see cref="Segment"/> на основе последовательности <paramref name="elements"/>.</para>


Suggested change

/// <para>Создаёт новый экземпляр класса <see cref="Segment"/> на основе последовательности <paramref name="elements"/>.</para>

/// <para>Создаёт новый экземпляр класса <see cref="Segment{T}"/> на основе последовательности <paramref name="elements"/>.</para>

FreePhoenix888 · 2021-09-11T15:31:37Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

+    /// <typeparam name="T">
+    /// <para>The sequence's element type.</para>
+    /// <para>Тип элемента последовательности.</para>
+    /// </typeparam>
    public abstract class AllSegmentsWalkerBase<T> : AllSegmentsWalkerBase<T, Segment<T>>
    {
        /// <summary>
        /// <para>Create a new instance of the <see cref="Segment"/> class based on <paramref name="elements"/> sequence.</para>


Suggested change

/// <para>Create a new instance of the <see cref="Segment"/> class based on <paramref name="elements"/> sequence.</para>

/// <para>Create a new instance of the <see cref="Segment{T}"/> class based on <paramref name="elements"/> sequence.</para>

Konard

Final touches.

Konard · 2021-09-17T16:16:02Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

-    /// Represents the all segments walker base.
-    /// </para>
-    /// <para></para>
+    /// <para>Represents a base class for walkers through all possible segments of a sequence.</para>


Suggested change

/// <para>Represents a base class for walkers through all possible segments of a sequence.</para>

/// <para>Represents the base class for walkers through all possible segments of a sequence.</para>

Konard · 2021-09-17T16:17:17Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

-    /// Represents the all segments walker base.
-    /// </para>
-    /// <para></para>
+    /// <para>Represents the base class for sinkers for all possible segments of the sequence.</para>


Suggested change

/// <para>Represents the base class for sinkers for all possible segments of the sequence.</para>

/// <para>Represents the base class for walkers through all possible segments of a sequence.</para>

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

Konard

Almost done.

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

TwinkmrMask

We kindly ask you to read the review carefully and ask questions if there are any

TwinkmrMask · 2021-10-03T15:54:26Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T, TSegment].cs

-        /// </para>
-        /// <para></para>
+        /// <para>Constructor referencing another constructor by passing a field to its parameter <see cref="DefaultMinimumStringSegmentLength"/>.</para>
+        /// <para>Конструктор, ссылающийся на другой конструктор, передавая в его параметр поле <see cref="DefaultMinimumStringSegmentLength"/>.</para>


Конструктор, ссылающийся на свою перегрузку, передавая в его параметр поле

The same as above

TwinkmrMask · 2021-10-03T15:55:16Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T, TSegment].cs

@@ -72,23 +64,23 @@ public virtual void WalkAll(IList<T> elements)
        /// <para>
        /// Creates the segment using the specified elements.
        /// </para>
-        /// <para></para>
+        /// <para>Представляет базовый метод, для всех методов создания мегмента.</para>


This translation is not correct

This documentation is incorrect. Check any documentation of abstract classes: Stream abstract class and its methods

TwinkmrMask · 2021-10-03T15:56:34Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T, TSegment].cs

@@ -97,7 +89,7 @@ public virtual void WalkAll(IList<T> elements)
        /// <para>
        /// Iterations the segment.


The description is not complete

TwinkmrMask · 2021-10-03T15:56:50Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T, TSegment].cs

@@ -97,7 +89,7 @@ public virtual void WalkAll(IList<T> elements)
        /// <para>
        /// Iterations the segment.
        /// </para>
-        /// <para></para>
+        /// <para>Представляет базоый метод, для всех методов итерации.</para>
        /// </summary>
        /// <param name="segment">
        /// <para>The segment.</para>


The description is not complete

FreePhoenix888 · 2021-10-04T04:37:38Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T, TSegment].cs

@@ -96,7 +89,7 @@ public virtual void WalkAll(IList<T> elements)
        /// <para>
        /// Iterations the segment.
        /// </para>
-        /// <para></para>
+        /// <para>Представляет базоый метод, для всех методов итерации.</para>


This documentation is incorrect. Check any documentation of abstract classes: Stream abstract class and its methods

FreePhoenix888 · 2021-10-04T04:38:23Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T, TSegment].cs

        /// </param>
        /// <returns>
-        /// <para>The segment</para>
-        /// <para></para>
+        /// <para>Created megment</para>


Where is an article?

FreePhoenix888 · 2021-10-04T04:39:28Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T, TSegment].cs

-        /// <param name="length">
-        /// <para>The length.</para>
-        /// <para></para>
+         /// <param name="length">


Delete extra space

FreePhoenix888 · 2021-10-04T04:40:00Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T, TSegment].cs

@@ -72,23 +64,23 @@ public virtual void WalkAll(IList<T> elements)
        /// <para>
        /// Creates the segment using the specified elements.
        /// </para>
-        /// <para></para>
+        /// <para>Представляет базовый метод, для всех методов создания мегмента.</para>


This documentation is incorrect. Check any documentation of abstract classes: Stream abstract class and its methods

FreePhoenix888 · 2021-10-04T04:41:21Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T, TSegment].cs

-    /// </para>
-    /// <para></para>
+    /// <para>Represents the base class for walkers through all possible segments of a sequence.</para>
+    /// <para>Представляет базовый класс для проходчиков по всем возможным сегментам последовательности.</para>
    /// </summary>
    /// <seealso cref="AllSegmentsWalkerBase"/>


What is this? seealso must be used inside tags like summary, param and so on

FreePhoenix888 · 2021-10-04T04:45:22Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T, TSegment].cs

        /// </summary>
        /// <param name="minimumStringSegmentLength">
-        /// <para>A minimum string segment length.</para>
-        /// <para></para>
+        /// <para>The parameter that takes a field <see cref="DefaultMinimumStringSegmentLength"/>.</para>


This description is not descriptive. Check how microsoft documentate parameters

FreePhoenix888 · 2021-10-04T04:45:28Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T, TSegment].cs

-        /// <para>A minimum string segment length.</para>
-        /// <para></para>
+        /// <para>The parameter that takes a field <see cref="DefaultMinimumStringSegmentLength"/>.</para>
+        /// <para>Параметр, принимающий поле <see cref="DefaultMinimumStringSegmentLength"/>.</para>


The same as above

FreePhoenix888 · 2021-10-04T04:45:48Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T, TSegment].cs

-        /// Initializes a new <see cref="AllSegmentsWalkerBase"/> instance.
-        /// </para>
-        /// <para></para>
+        /// <para>Constructor referencing another constructor by passing a field to its parameter <see cref="DefaultMinimumStringSegmentLength"/>.</para>


The same as above

FreePhoenix888 · 2021-10-04T04:45:51Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T, TSegment].cs

-        /// </para>
-        /// <para></para>
+        /// <para>Constructor referencing another constructor by passing a field to its parameter <see cref="DefaultMinimumStringSegmentLength"/>.</para>
+        /// <para>Конструктор, ссылающийся на другой конструктор, передавая в его параметр поле <see cref="DefaultMinimumStringSegmentLength"/>.</para>


The same as above

FreePhoenix888 · 2021-10-04T04:46:45Z

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

@@ -3,19 +3,17 @@
 namespace Platform.Collections.Segments.Walkers


Remove the pragma statement above because XML comments are not missing now

kiritozevs added 4 commits August 26, 2021 17:18

Documentation for file AllSegmentsWalkerBase

d5ffa31

Documentation for file AllSegmentsWalkerBase

8b3574c

new documentation for a AllSegmentsWalkerBase[T]

15e2219

new documentation for a AllSegmentsWalkerBase[T]

1aedf15

kiritozevs requested a review from FreePhoenix888 August 27, 2021 13:28

FreePhoenix888 requested changes Aug 27, 2021

View reviewed changes

kiritozevs added 3 commits August 27, 2021 22:04

New version

7794022

New version2

1e58742

New version3

612af57

FreePhoenix888 requested changes Aug 28, 2021

View reviewed changes

uselessgoddess reviewed Aug 28, 2021

View reviewed changes

kiritozevs added 2 commits August 28, 2021 17:32

Opa Gan Gnam Style

d325d15

Opa Gan Gnam Style2

b598dd9

FreePhoenix888 requested changes Aug 28, 2021

View reviewed changes

uselessgoddess approved these changes Aug 28, 2021

View reviewed changes

Opa Gan Gnam Style3

0f9964a

FreePhoenix888 requested changes Aug 28, 2021

View reviewed changes

Opa Gan Gnam Style 2.1

3c54612

FreePhoenix888 approved these changes Aug 28, 2021

View reviewed changes

FreePhoenix888 requested a review from Konard August 28, 2021 15:59

uselessgoddess requested changes Aug 29, 2021

View reviewed changes

kiritozevs added 3 commits August 29, 2021 15:12

new elemets param text

eeb35b3

new elemets param text2

56a0b4c

100 Thousand Hour Leter

55e6fae

uselessgoddess reviewed Aug 29, 2021

View reviewed changes

Probel

f541c3f

uselessgoddess reviewed Aug 29, 2021

View reviewed changes

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs Outdated Show resolved Hide resolved

TwinkmrMask reviewed Aug 29, 2021

View reviewed changes

FreePhoenix888 requested changes Aug 30, 2021

View reviewed changes

kiritozevs added 5 commits August 30, 2021 13:35

Delete Probel

ccbd3c7

This

f275571

This2

6ce8fe7

Meybe_Last

1c0eade

Return

90dd4ce

Konard requested changes Sep 3, 2021

View reviewed changes

kiritozevs added 3 commits September 4, 2021 14:10

konstantin

804cd45

new_english_new_files

bc38b9a

new_english_new_files2

57c4fdc

Konard requested changes Sep 4, 2021

View reviewed changes

uselessgoddess approved these changes Sep 4, 2021

View reviewed changes

New_Commit

2af9353

FreePhoenix888 requested changes Sep 8, 2021

View reviewed changes

kiritozevs added 2 commits September 10, 2021 22:41

new_text

79f9aa3

extra-puper-probel

1ec0d84

FreePhoenix888 requested changes Sep 11, 2021

View reviewed changes

{T}

292c04c

Konard requested changes Sep 17, 2021

View reviewed changes

6_and_9_string

d22f982

FreePhoenix888 approved these changes Sep 18, 2021

View reviewed changes

Konard requested changes Sep 19, 2021

View reviewed changes

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs Show resolved Hide resolved

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs Show resolved Hide resolved

kiritozevs added 2 commits September 22, 2021 21:58

seealso_in_3_files

27baa4c

t_tsegment_class_documentation

c40fddc

TwinkmrMask reviewed Oct 3, 2021

View reviewed changes

FreePhoenix888 requested changes Oct 4, 2021

View reviewed changes

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

	/// <para>Возвращает дефолтную минимальную длинну строки мегмента.</para>
	/// <para>Равняется минимально допустимой длиной сегмента.</para>

	/// <para>Предоставляет базовый класс, от которого наследуются классы, реализующие AllSegmentsWalkerBase. Это абстрактный класс.</para>
	/// <para>Базовый абстрактный класс для всех [вставьте тут синоним слова "волкеров"]</para>

		/// <para>Instance of the Segment class<T></para>
		/// <para>Экземпляр класса Segment</para>

	/// <para>Gets default minimum string segment length.</para>
	/// <para>Gets a default minimum length of string segment.</para>

	/// <param name="elements"><para>A reference to the original list containing the elements of this segment.</para>
	/// <param name="elements">
	<para>A reference to the original list containing the elements of this segment.</para>

	/// <param name="elements"><para>A reference to the original list containing the elements of this segment.</para>
	/// <param name="elements">
	/// <para>A reference to the original list containing the elements of this segment.</para>

	/// <para>Ссылка на исходный список в котором находятся элементы этого сегмента.</para></param>
	/// <para>Ссылка на исходный список в котором находятся элементы этого сегмента.</para>
	</param>

	/// <param name="offset"><para>The offset relative to the <paramref name="elements"/> list from which the segment starts.</para>
	/// <param name="offset">
	<para>An offset relative to the <paramref name="elements"/> list from which the segment starts.</para>

	/// <para>Смещение относительно списка <paramref name="elements"/>, с которого начинается сегмент.</para></param>
	/// <para>Смещение относительно списка <paramref name="elements"/>, с которого начинается сегмент.</para>
	</param>

	/// <param name="length"><para>The segment's length.</para>
	/// <param name="length">
	<para>A length of the segment.</para>

	/// <para>Длина сегмента.</para></param>
	/// <para>Длина сегмента.</para>
	</param>

	/// <para>Gets instance of the <see cref="Segment"/> class<T></para>
	/// <para>Initiailizes a new instance of the <see cref="Segment"/> class<T></para>

	/// <para>Возвращает экземпляр класса <see cref="Segment"/></para>
	/// <para>Инициализирует новый экземпляр класса <see cref="Segment"/></para>

	/// <para>>Gets a default minimum length of string segment.</para>
	/// <para>Gets a default minimum length of the string segment.</para>

	/// <para>The offset relative to the <paramref name="elements"/> list from which the segment starts.</para>
	/// <para>An offset relative to the <paramref name="elements"/> list from which the segment starts.</para>

	/// <para>The segment's length.</para>
	/// <para>A segment's length.</para>

	/// <para>instance of the <see cref="Segment"/> class<T></para>
	/// <para>An instance of the <see cref="Segment{T}"/> class.</para>

	/// <para>экземпляр класса <see cref="Segment"/></para>
	/// <para>Экземпляр класса <see cref="Segment{T}"/>.</para>

	/// <para>Представляет базовый абстрактный класс для проходчиков по всем элементам.</para>
	/// <para>Базовый абстрактный класс для проходчиков по всем элементам.</para>

	/// <para>Возвращает минимально допустимую длину сегмента.</para>
	/// <para>Минимально допустимая длина сегмента.</para>

AllSegmentsWalkerBase new documentation #137

Are you sure you want to change the base?

AllSegmentsWalkerBase new documentation #137

Conversation

kiritozevs commented Aug 26, 2021

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

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

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

uselessgoddess 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

uselessgoddess 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

TwinkmrMask 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

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

uselessgoddess 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

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

Konard left a comment

Choose a reason for hiding this comment

TwinkmrMask left a comment

	/// <para>Инициализирует новый экземпляр класса <see cref="Segment"/></para>
	/// <para>Создаёт новый экземпляр класса <see cref="Segment"/></para>

	/// <para>Ссылка на исходный список в котором находятся элементы этого сегмента.</para>
	/// <para>Исходный список в котором находятся элементы этого сегмента.</para>

	/// <para>An offset relative to the <paramref name="elements"/> list from which the segment starts.</para>
	/// <para>An offset relative to the start of the<paramref name="elements"/> from which the segment starts.</para>

	/// <para>Represents the base class for sinkers for all possible segments of the sequence.</para>
	/// <para>Represents a base class for walkers through all possible segments of a sequence.</para>

	/// <para>List of elements.</para>
	/// <para>A list of elements.</para>

	/// <para>A read-only field that represents the minimum length of the default sequence segment.</para>
	/// <para>A read-only field that represents the default minimum length of the sequence segment.</para>

	/// <para>Create a new instance of the <see cref="Segment"/> class based on <paramref name="elements"/> sequence.</para>
	/// <para>Create a new instance of the <see cref="Segment{T}"/> class based on <paramref name="elements"/> sequence.</para>

		@@ -97,7 +89,7 @@ public virtual void WalkAll(IList<T> elements)
		/// <para>
		/// Iterations the segment.

		@@ -3,19 +3,17 @@
		namespace Platform.Collections.Segments.Walkers