comments updated

Author: e11sy

src/domain/service/note.ts

@@ -416,7 +416,7 @@ export default class NoteService {
    * Get concrete history record of the note
    * Used for showing some of the note content versions
    * @param id - id of the note history record
-   * @returns full public note history record or raises domain error if record not found
+   * @returns full public note history record with user information or raises domain error if record not found
    */
   public async getHistoryRecordById(id: NoteHistoryRecord['id']): Promise<NoteHistoryPublic> {
     const noteHistoryRecord = await this.noteHistoryRepository.getHistoryRecordById(id);

src/repository/noteHistory.repository.ts

@@ -36,7 +36,7 @@ export default class NoteHistoryRepository {
    * Get concrete history record by it's id
    * Used for presentation of certain version of note content saved in history
    * @param id - id of the history record
-   * @returns full history record or null if there is no record with such an id
+   * @returns full history record with user information or null if there is no record with such an id
    */
   public async getHistoryRecordById(id: NoteHistoryRecord['id']): Promise<NoteHistoryView | null> {
     return await this.storage.getHistoryRecordById(id);

src/repository/storage/postgres/orm/sequelize/noteHistory.ts

@@ -161,7 +161,7 @@ export default class NoteHistorySequelizeStorage {
   /**
    * Get concrete history record by it's id
    * @param id - id of the history record
-   * @returns full history record or null if there is no record with such an id
+   * @returns full history record with user information or null if there is no record with such an id
    */
   public async getHistoryRecordById(id: NoteHistoryRecord['id']): Promise<NoteHistoryView | null> {
     const historyView = await this.model.findOne({