From 3291b434231fdd29dbd9f3055661fe4e70fb9e02 Mon Sep 17 00:00:00 2001
From: Philip Molares <philip.molares@udo.edu>
Date: Sat, 6 Nov 2021 11:49:26 +0100
Subject: [PATCH] docs: fix createUser and test docs

this ports the fixes applied to createGroup to this method as well

Signed-off-by: Philip Molares <philip.molares@udo.edu>
---
 src/users/users.service.spec.ts | 3 ++-
 src/users/users.service.ts      | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/users/users.service.spec.ts b/src/users/users.service.spec.ts
index a7f97659e..693187e74 100644
--- a/src/users/users.service.spec.ts
+++ b/src/users/users.service.spec.ts
@@ -52,12 +52,13 @@ describe('UsersService', () => {
         .spyOn(userRepo, 'save')
         .mockImplementationOnce(async (user: User): Promise<User> => user);
     });
-    it('works', async () => {
+    it('successfully creates a user', async () => {
       const user = await service.createUser(username, displayname);
       expect(user.username).toEqual(username);
       expect(user.displayName).toEqual(displayname);
     });
     it('fails if username is already taken', async () => {
+      // add additional mock implementation for failure
       jest.spyOn(userRepo, 'save').mockImplementationOnce(() => {
         throw new Error();
       });
diff --git a/src/users/users.service.ts b/src/users/users.service.ts
index 75b9415b4..16fb5551f 100644
--- a/src/users/users.service.ts
+++ b/src/users/users.service.ts
@@ -26,7 +26,7 @@ export class UsersService {
    * @async
    * Create a new user with a given username and displayName
    * @param username - the username the new user shall have
-   * @param displayName - the display the new user shall have
+   * @param displayName - the display name the new user shall have
    * @return {User} the user
    * @throws {AlreadyInDBError} the username is already taken.
    */