Skip to content

Commit 7e0ee82

Browse files
authored
Update guidelines for object descriptions (#202)
1 parent 496250a commit 7e0ee82

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/development-guide/read-first/guidelines.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,11 @@ Exceptions for existing objects:
2020

2121
#### Object Prefixing
2222

23-
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 - ...`.
23+
Classes and interfaces are prefixed using `zcl_abapgit_` or `zif_abapgit_` (`zcx_abapgit_` for exception classes, `lcl_` and `ltcl_` for local and test classes).
24+
25+
### Object Descriptions
26+
27+
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)`).
2428

2529
#### Variable Prefixing
2630

0 commit comments

Comments
 (0)