Add some missing periods.

README.md

@@ -53,7 +53,7 @@ yarn build
 ```
 
 * You must describe your event using `description` fields. Your audience might be unfamiliar with the codebase, 
-  or non-technical, so don't refer to code concepts and try to describe things in general but accurate terms.
+  or non-technical, so don't refer to code concepts and try to describe things in general but accurate terms. English grammar must be respected, in particular sentences must end with punctuation (eg a period).
 
 ### Description examples
 
@@ -62,7 +62,7 @@ yarn build
 ```json
 {
   "type": "object",
-  "description": "Triggered when the user changed screen",
+  "description": "Triggered when the user changed screen.",
   "properties": {
     "eventName": {
       "enum": ["Screen"]

schemas/Error.json

@@ -1,6 +1,6 @@
 {
   "type": "object",
-  "description": "Triggered when an error occurred",
+  "description": "Triggered when an error occurred.",
   "properties": {
     "eventName": {
       "enum": ["Error"]
@@ -27,7 +27,7 @@
       ]
     },
     "context": {
-      "description": "Context - client defined, can be used for debugging",
+      "description": "Context - client defined, can be used for debugging.",
       "type": "string"
     }
   },

schemas/JoinedRoom.json

@@ -16,7 +16,7 @@
        {"const": "SpaceHierarchy", "description": "Room joined via the space hierarchy view."},
        {"const": "Timeline", "description": "Room joined via a timeline pill or link in another room."},
        {"const": "Notification", "description": "Room joined via a push/desktop notification."},
-       {"const": "MobilePermalink", "description": "Room joined via link"}
+       {"const": "MobilePermalink", "description": "Room joined via link."}
      ]
     },
     "roomSize": {

schemas/MobileScreen.json

@@ -1,6 +1,6 @@
 {
   "type": "object",
-  "description": "Triggered when the user changed screen on Element Android/iOS",
+  "description": "Triggered when the user changed screen on Element Android/iOS.",
   "properties": {
     "eventName": {
       "enum": ["$screen"]
@@ -11,8 +11,8 @@
         {"const": "Home", "description": "The Home tab on iOS | possibly the same on Android?"},
         {"const": "Welcome", "description": "The splash screen."},
         {"const": "Login", "description": "The screen that displays the login flow (when the user already has an account)."},
-        {"const": "ForgotPassword", "description": "The form for the forgot password use case"},
-        {"const": "Register", "description": "The screen that displays the registration flow (when the user wants to create an account)"},
+        {"const": "ForgotPassword", "description": "The form for the forgot password use case."},
+        {"const": "Register", "description": "The screen that displays the registration flow (when the user wants to create an account)."},
         {"const": "Room", "description": "The screen that displays the messages and events received in a room."},
         {"const": "RoomDetails", "description": "The screen shown when tapping the name of a room from the Room screen."},
         {"const": "RoomMembers", "description": "The screen that displays the list of members that are part of a room."},
@@ -30,7 +30,7 @@
         {"const": "DeactivateAccount", "description": "The confirmation screen shown before deactivating an account."},
         {"const": "Group", "description": "Legacy: The screen that shows information about a specific group."},
         {"const": "MyGroups", "description": "Legacy: The screen that shows all groups/communities you have joined."},
-        {"const": "SpaceExploreRooms", "description": "Screen that displays the list of rooms and spaces of a space"},
+        {"const": "SpaceExploreRooms", "description": "Screen that displays the list of rooms and spaces of a space."},
         {"const": "Sidebar", "description": "The sidebar shown on mobile with spaces, settings etc."},
         {"const": "Favourites", "description": "The Favourites tab on mobile that lists your favourite people/rooms."},
         {"const": "People", "description": "The People tab on mobile that lists all the DM rooms you have joined."},
@@ -51,15 +51,15 @@
         {"const": "SettingsPreferences", "description": "The preferences screen (theme, language, editor preferences, etc."},
         {"const": "SettingsVoiceVideo", "description": "The calls settings screen."},
         {"const": "SettingsIgnoredUsers", "description": "The settings screen with list of the ignored users."},
-        {"const": "SettingsLabs", "description": "The experimental features settings screen,"},
-        {"const": "SettingsAdvanced", "description": "The advanced settings screen (developer mode, rageshake, push notification rules)"},
-        {"const": "SettingsHelp", "description": "The Help and About screen"},
-        {"const": "SettingsLegals", "description": "The settings screen with legals information"},
+        {"const": "SettingsLabs", "description": "The experimental features settings screen."},
+        {"const": "SettingsAdvanced", "description": "The advanced settings screen (developer mode, rageshake, push notification rules)."},
+        {"const": "SettingsHelp", "description": "The Help and About screen."},
+        {"const": "SettingsLegals", "description": "The settings screen with legals information."},
         {"const": "SettingsMentionsAndKeywords", "description": "The settings screen to manage notification mentions and keywords."},
-        {"const": "SpaceMenu", "description": "The bottom sheet that list all space options"},
-        {"const": "SpaceMembers", "description": "Screen that displays the list of members of a space"},
-        {"const": "RoomPreview", "description": "Screen that displays room preview if user hasn't joined yet"},
-        {"const": "ThreadList", "description": "Screen that displays list of threads for a room"}
+        {"const": "SpaceMenu", "description": "The bottom sheet that list all space options."},
+        {"const": "SpaceMembers", "description": "Screen that displays the list of members of a space."},
+        {"const": "RoomPreview", "description": "Screen that displays room preview if user hasn't joined yet."},
+        {"const": "ThreadList", "description": "Screen that displays list of threads for a room."}
       ]
     },
     "durationMs": {

schemas/UserProperties.json

@@ -13,31 +13,31 @@
         ]
       },
       "numSpaces": {
-        "description": "Number of spaces (and sub-spaces) the user is joined to",
+        "description": "Number of spaces (and sub-spaces) the user is joined to.",
         "type": "integer"
       },
       "numFavouriteRooms": {
-        "description": "Number of joined rooms the user has favourited",
+        "description": "Number of joined rooms the user has favourited.",
         "type": "integer"
       },
       "WebMetaSpaceHomeEnabled": {
-        "description": "Whether the user has the home space enabled",
+        "description": "Whether the user has the home space enabled.",
         "type": "boolean"
       },
       "WebMetaSpaceHomeAllRooms": {
-        "description": "Whether the user has the home space set to all rooms",
+        "description": "Whether the user has the home space set to all rooms.",
         "type": "boolean"
       },
       "WebMetaSpacePeopleEnabled": {
-        "description": "Whether the user has the people space enabled",
+        "description": "Whether the user has the people space enabled.",
         "type": "boolean"
       },
       "WebMetaSpaceFavouritesEnabled": {
-        "description": "Whether the user has the favourites space enabled",
+        "description": "Whether the user has the favourites space enabled.",
         "type": "boolean"
       },
       "WebMetaSpaceOrphansEnabled": {
-        "description": "Whether the user has the other rooms space enabled",
+        "description": "Whether the user has the other rooms space enabled.",
         "type": "boolean"
       }
     },

schemas/ViewRoom.json

@@ -45,11 +45,11 @@
         {"const": "MobileInCall", "description": "Room accessed via interacting with the incall screen."},
         {"const": "MobileSpaceMenu", "description": "Space accessed via interacting with the space menu."},
         {"const": "MobileSpaceSettings", "description": "Space accessed via interacting with a space settings menu item."},
-        {"const": "MobileRoomPreview", "description": "Room accessed via preview"},
-        {"const": "MobilePermalink", "description": "Room accessed via link"},
-        {"const": "MobileLinkShare", "description": "Room accessed during external sharing"},
-        {"const": "MobileExploreRooms", "description": "Room accessed via space explore"},
-        {"const": "MobileSpaceMembers", "description": "Room accessed via space members list"}
+        {"const": "MobileRoomPreview", "description": "Room accessed via preview."},
+        {"const": "MobilePermalink", "description": "Room accessed via link."},
+        {"const": "MobileLinkShare", "description": "Room accessed during external sharing."},
+        {"const": "MobileExploreRooms", "description": "Room accessed via space explore."},
+        {"const": "MobileSpaceMembers", "description": "Room accessed via space members list."}
       ]
     },
     "viaKeyboard": {

types/kotlin2/Error.kt

@@ -22,11 +22,11 @@ import im.vector.app.features.analytics.itf.VectorAnalyticsEvent
 // https://github.com/matrix-org/matrix-analytics-events/
 
 /**
- * Triggered when an error occurred
+ * Triggered when an error occurred.
  */
 data class Error(
         /**
-         * Context - client defined, can be used for debugging
+         * Context - client defined, can be used for debugging.
          */
         val context: String? = null,
         val domain: Domain,

types/kotlin2/JoinedRoom.kt

@@ -50,7 +50,7 @@ data class JoinedRoom(
         Invite,
 
         /**
-         * Room joined via link
+         * Room joined via link.
          */
         MobilePermalink,
 

types/kotlin2/MobileScreen.kt

@@ -22,7 +22,7 @@ import im.vector.app.features.analytics.itf.VectorAnalyticsScreen
 // https://github.com/matrix-org/matrix-analytics-events/
 
 /**
- * Triggered when the user changed screen on Element Android/iOS
+ * Triggered when the user changed screen on Element Android/iOS.
  */
 data class MobileScreen(
         /**
@@ -59,7 +59,7 @@ data class MobileScreen(
         Favourites,
 
         /**
-         * The form for the forgot password use case
+         * The form for the forgot password use case.
          */
         ForgotPassword,
 
@@ -96,7 +96,7 @@ data class MobileScreen(
 
         /**
          * The screen that displays the registration flow (when the user wants
-         * to create an account)
+         * to create an account).
          */
         Register,
 
@@ -143,7 +143,7 @@ data class MobileScreen(
         RoomPermissions,
 
         /**
-         * Screen that displays room preview if user hasn't joined yet
+         * Screen that displays room preview if user hasn't joined yet.
          */
         RoomPreview,
 
@@ -197,7 +197,7 @@ data class MobileScreen(
 
         /**
          * The advanced settings screen (developer mode, rageshake, push
-         * notification rules)
+         * notification rules).
          */
         SettingsAdvanced,
 
@@ -212,7 +212,7 @@ data class MobileScreen(
         SettingsGeneral,
 
         /**
-         * The Help and About screen
+         * The Help and About screen.
          */
         SettingsHelp,
 
@@ -222,12 +222,12 @@ data class MobileScreen(
         SettingsIgnoredUsers,
 
         /**
-         * The experimental features settings screen,
+         * The experimental features settings screen.
          */
         SettingsLabs,
 
         /**
-         * The settings screen with legals information
+         * The settings screen with legals information.
          */
         SettingsLegals,
 
@@ -262,17 +262,17 @@ data class MobileScreen(
         Sidebar,
 
         /**
-         * Screen that displays the list of rooms and spaces of a space
+         * Screen that displays the list of rooms and spaces of a space.
          */
         SpaceExploreRooms,
 
         /**
-         * Screen that displays the list of members of a space
+         * Screen that displays the list of members of a space.
          */
         SpaceMembers,
 
         /**
-         * The bottom sheet that list all space options
+         * The bottom sheet that list all space options.
          */
         SpaceMenu,
 
@@ -287,7 +287,7 @@ data class MobileScreen(
         SwitchDirectory,
 
         /**
-         * Screen that displays list of threads for a room
+         * Screen that displays list of threads for a room.
          */
         ThreadList,
 

types/kotlin2/UserProperties.kt

@@ -25,35 +25,35 @@ package im.vector.app.features.analytics.plan
  */
 data class UserProperties(
         /**
-         * Whether the user has the favourites space enabled
+         * Whether the user has the favourites space enabled.
          */
         val WebMetaSpaceFavouritesEnabled: Boolean? = null,
         /**
-         * Whether the user has the home space set to all rooms
+         * Whether the user has the home space set to all rooms.
          */
         val WebMetaSpaceHomeAllRooms: Boolean? = null,
         /**
-         * Whether the user has the home space enabled
+         * Whether the user has the home space enabled.
          */
         val WebMetaSpaceHomeEnabled: Boolean? = null,
         /**
-         * Whether the user has the other rooms space enabled
+         * Whether the user has the other rooms space enabled.
          */
         val WebMetaSpaceOrphansEnabled: Boolean? = null,
         /**
-         * Whether the user has the people space enabled
+         * Whether the user has the people space enabled.
          */
         val WebMetaSpacePeopleEnabled: Boolean? = null,
         /**
          * The selected messaging use case during the onboarding flow.
          */
         val ftueUseCaseSelection: FtueUseCaseSelection? = null,
         /**
-         * Number of joined rooms the user has favourited
+         * Number of joined rooms the user has favourited.
          */
         val numFavouriteRooms: Int? = null,
         /**
-         * Number of spaces (and sub-spaces) the user is joined to
+         * Number of spaces (and sub-spaces) the user is joined to.
          */
         val numSpaces: Int? = null,
 ) {

types/kotlin2/ViewRoom.kt

@@ -64,7 +64,7 @@ data class ViewRoom(
         MessageUser,
 
         /**
-         * Room accessed via space explore
+         * Room accessed via space explore.
          */
         MobileExploreRooms,
 
@@ -79,12 +79,12 @@ data class ViewRoom(
         MobileInCall,
 
         /**
-         * Room accessed during external sharing
+         * Room accessed during external sharing.
          */
         MobileLinkShare,
 
         /**
-         * Room accessed via link
+         * Room accessed via link.
          */
         MobilePermalink,
 
@@ -95,7 +95,7 @@ data class ViewRoom(
         MobileRoomMemberDetail,
 
         /**
-         * Room accessed via preview
+         * Room accessed via preview.
          */
         MobileRoomPreview,
 
@@ -117,7 +117,7 @@ data class ViewRoom(
         MobileSpaceMemberDetail,
 
         /**
-         * Room accessed via space members list
+         * Room accessed via space members list.
          */
         MobileSpaceMembers,