Skip to content

Commit

Permalink
chore: #99 Typos fix, javadoc minor improvements.
Browse files Browse the repository at this point in the history
  • Loading branch information
dmitry-weirdo committed Nov 20, 2024
1 parent 6fcb37c commit 2b08b32
Show file tree
Hide file tree
Showing 7 changed files with 77 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ void testCarById() {
assertThat(publishedPersonalCarByPersonalId).isEqualTo(Car.TRAM);

assertThatThrownBy(() -> {
Car.getById(0);// non-existing car id
Car.getById(0); // non-existing car id
})
.isInstanceOf(IllegalArgumentException.class)
.hasMessageContaining("0 cars")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
import java.util.Comparator;

/**
* Упорядочивает игроков сначала по убыванию количества доездов в соревновании
* , а внутри одинакового количества заездов — по имени.
* Упорядочивает игроков сначала по убыванию количества доездов в соревновании,
* а внутри одинакового количества заездов — по имени.
*/
public class PlayersBasicInfoComparator implements Comparator<PlayerBasicInfo>
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,27 +50,56 @@ public class PlayerVocabularyDto

// данные игрока по конкретному словарю, PlayerVocabularyStatsEntity

private Integer racesCount; // пробег игрока по словарю
/**
* Пробег игрока по словарю.
*/
private Integer racesCount;

private Double averageSpeed; // средняя скорость игрока по словарю, знаков в минуту
/**
* Средняя скорость игрока по словарю, знаков в минуту.
*/
private Double averageSpeed;

private Integer bestSpeed; // рекорд игрока по словарю, знаков в минуту
/**
* Рекорд игрока по словарю, знаков в минуту.
*/
private Integer bestSpeed;

private Double averageError; // процент ошибок игрока по словарю, в процентах
/**
* Процент ошибок игрока по словарю, в процентах.
*/
private Double averageError; //

private String haul; // время, проведённое игроком в словаре, в секундах. Отформатированное для показа в UI
/**
* Время, проведённое игроком в словаре, в секундах. Отформатированное для показа в UI.
*/
private String haul;

private Integer haulInteger; // true haul, for order number
/**
* True haul, for order number.
*/
private Integer haulInteger;

private Integer qual; // на сколько пройдена квалификация по словарю. Рекорды в словаре засчитываются в пределах 1.2 * qual.
/**
* На сколько пройдена квалификация по словарю. Рекорды в словаре засчитываются в пределах 1.2 * qual.
*/
private Integer qual;

// don't care about dirty
// string since Java8 Date/Time formatting does not work in Freemarker
// see https://stackoverflow.com/questions/32063276/java-time-java-8-support-in-freemarker
private String updated; // Время апдейта результата игроков по словарю. Московское время.
/**
* Время апдейта результата игроков по словарю. Московское время.
*/
private String updated;

// exact value of PlayerVocabularyStatsEntity#updated, for Excel
/**
* Exact value of PlayerVocabularyStatsEntity#updated, for Excel
*/
private LocalDateTime updatedDateTime;

private Boolean bookDone; // пройдена ли книга. Заполнено только для словарей-книг.
/**
* Пройдена ли книга. Заполнено только для словарей-книг.
*/
private Boolean bookDone;
}
Original file line number Diff line number Diff line change
Expand Up @@ -85,21 +85,45 @@ public class PlayerVocabularyStatsEntity implements Serializable {
*/
private Integer vocabularyTextType;

private Integer racesCount; // пробег игрока по словарю
/**
* Пробег игрока по словарю.
*/
private Integer racesCount;

private Double averageSpeed; // средняя скорость игрока по словарю, знаков в минуту
/**
* Средняя скорость игрока по словарю, знаков в минуту.
*/
private Double averageSpeed;

private Integer bestSpeed; // рекорд игрока по словарю, знаков в минуту
/**
* Рекорд игрока по словарю, знаков в минуту.
*/
private Integer bestSpeed;

private Double averageError; // процент ошибок игрока по словарю, в процентах
/**
* Процент ошибок игрока по словарю, в процентах.
*/
private Double averageError;

private Integer haul; // время, проведённое игроком в словаре, в секундах
/**
* Время, проведённое игроком в словаре, в секундах
*/
private Integer haul;

private Integer qual; // на сколько пройдена квалификация по словарю. Рекорды в словаре засчитываются в пределах 1.2 * qual.
/**
* На сколько пройдена квалификация по словарю. Рекорды в словаре засчитываются в пределах 1.2 * qual.
*/
private Integer qual;

private Integer dirty; // todo: wtf is this?

private LocalDateTime updated; // Время апдейта результата игроков по словарю. Московское время.
/**
* Время апдейта результата игроков по словарю. Московское время.
*/
private LocalDateTime updated;

private Boolean bookDone; // пройдена ли книга. Заполнено только для словарей-книг.
/**
* Пройдена ли книга. Заполнено только для словарей-книг.
*/
private Boolean bookDone;
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

/**
* We cannot use more than 64000 cell styles in Excel template.
* Therefore we have to pre-create all required styles and reuse them.
* Therefore, we have to pre-create all required styles and reuse them.
* @see <a href="https://bz.apache.org/bugzilla/show_bug.cgi?id=63613">Bug in Apache POI</a>
* @see <a href="https://docs.microsoft.com/en-us/office/troubleshoot/excel/too-many-different-cell-formats-in-excel">You receive a "Too many different cell formats" error message in Excel</a>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public abstract class ExcelTemplate<D extends ExcelExportContextData> {

protected List<D> players = new ArrayList<>();

// Sheet name in excel is limited to 31 chars, it will be to 31 characters if too long
// Sheet name in Excel is limited to 31 chars, it will be to 31 characters if too long
// @see https://excel.uservoice.com/forums/304921-excel-for-windows-desktop-application/suggestions/10770162-allow-31-characters-in-a-sheet-name
public abstract String getSheetName();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,7 @@ void brandNewPlayer() {
.hasBookDone(null) // bookDone set for book dictionaries only
;

// minimal 0/null info for a brand new user
// minimal 0/null info for a brand-new user
GetStatsOverviewGameTypeInfo normalStatsInfo = normalStats.getInfo();
GetStatsOverviewGameTypeInfoAssert
.assertThat(normalStatsInfo)
Expand Down

0 comments on commit 2b08b32

Please sign in to comment.