From 2ba4b15fdd1da6cb82f8786df7620004ef17d094 Mon Sep 17 00:00:00 2001 From: Marc Bernard <59966492+mbtools@users.noreply.github.com> Date: Thu, 25 Jan 2024 11:01:24 +0100 Subject: [PATCH] Update guidelines for object descriptions --- src/development-guide/read-first/guidelines.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/development-guide/read-first/guidelines.md b/src/development-guide/read-first/guidelines.md index 876b425ad..e315c2d92 100755 --- a/src/development-guide/read-first/guidelines.md +++ b/src/development-guide/read-first/guidelines.md @@ -20,7 +20,11 @@ Exceptions for existing objects: #### Object Prefixing -Classes and interfaces are prefixed using `zcl_abapgit_` or `zif_abapgit_` (`zcx_abapgit_` for exception classes, `lcl_` and `ltcl_` for local and test classes). The description of objects should begin with `abapGit - ...`. +Classes and interfaces are prefixed using `zcl_abapgit_` or `zif_abapgit_` (`zcx_abapgit_` for exception classes, `lcl_` and `ltcl_` for local and test classes). + +### Object Descriptions + +The description of objects should begin with `abapGit - ...` (for example, `abapGit - Repository Content List`). For [serializer classes](/development-guide/serializers/overview.html), the text should contain the `TADIR` object type and description (for example, `abapGit - INTF - Interface (ABAP Objects)`). #### Variable Prefixing