#155 - Improve direct commit docs (#156)

- Improved docs. Added warning for `warning` disable.

Author: miroslavpojer

README.md

@@ -74,6 +74,11 @@ Generate Release Notes action is dedicated to enhance the quality and organizati
 | `warnings` | Set to true to print service chapters in the release notes. These warnings identify issues without release notes, without user-defined labels, or without associated pull requests, and PRs without linked issues. | No       | true (Service chapters are printed.) |  
 | `print-empty-chapters` | Set it to true to print chapters with no issues or PRs. | No       | true (Empty chapters are printed.) | 
 
+> [!WARNING]
+> - `warnings`
+>   - **Disabling this feature will hide service chapter showing direct commits!** These cannot be visible in custom chapters as they do not have labels!
+
+
 ## Outputs
 The output of the action is a markdown string containing the release notes for the specified tag. This string can be used in subsequent steps to publish the release notes to a file, create a GitHub release, or send notifications.
 

release_notes_generator/model/service_chapters.py

@@ -105,10 +105,11 @@ def populate(self, records: dict[int | str, Record]) -> None:
             if record.skip:
                 continue
 
-            # skip the record when used in used and not allowed to be duplicated in Service chapters
+            # skip the record when already used and not allowed to be duplicated in Service chapters
             if self.__is_row_present(record_id) and not self.duplicity_allowed():
                 continue
 
+            # main three situations:
             if record.is_closed and isinstance(record, IssueRecord):
                 self.__populate_closed_issues(cast(IssueRecord, record), record_id)
 
@@ -118,12 +119,14 @@ def populate(self, records: dict[int | str, Record]) -> None:
             elif isinstance(record, CommitRecord):
                 self.__populate_direct_commit(cast(CommitRecord, record), record_id)
 
+            # other edge case situations
             else:
                 if (
                     record.is_open
                     and isinstance(record, IssueRecord)
                     and cast(IssueRecord, record).pull_requests_count() == 0
                 ):
+                    # no change increment delivered
                     pass
                 elif (
                     record.is_open
@@ -164,7 +167,7 @@ def __populate_closed_issues(self, record: IssueRecord, record_id: int | str) ->
             populated = True
 
         if pulls_count > 0:
-            # the record looks to be valid closed issue with 1+ pull requests
+            # the record looks to be valid closed issue with 1+ pull requests, no reason to report it
             return
 
         if not populated: