_group_argument_list does not document PythonArgumentStructureError #76

New Issue

2026-10-27T22:43:07+01:00

jakob.scheid commented

2026-10-27 22:43:07 +01:00

Problem

The _group_argument_list function in the Python core module (src/jcloud_docsgen/core/python/_core.py) does not document the PythonArgumentStructureError that could be risen in its docstring. As a result, it is not clear that the function raises an error in some cases (if arguments follow a var-keyword argument). Even if it is an internal function, it is important to mention that the exception can be risen as it can cause the program to crash if it is not handled.

Goal

The docstring of the _group_argument_list function documents the PythonArgumentStructureError according the docstring syntax used throughout the project. There is a description of the cases in which the exception is risen.

## Problem The `_group_argument_list` function in the Python core module (`src/jcloud_docsgen/core/python/_core.py`) does not document the `PythonArgumentStructureError` that could be risen in its docstring. As a result, it is not clear that the function raises an error in some cases (if arguments follow a var-keyword argument). Even if it is an internal function, it is important to mention that the exception can be risen as it can cause the program to crash if it is not handled. ## Goal The docstring of the `_group_argument_list` function documents the `PythonArgumentStructureError` according the docstring syntax used throughout the project. There is a description of the cases in which the exception is risen.

jakob.scheid added the Kind/Documentation

Priority

Low

4

labels 2026-10-27 22:43:07 +01:00

jakob.scheid added this to the Project Board project 2026-10-27 22:43:07 +01:00

jakob.scheid added this to the 0.2.4 milestone 2026-10-27 22:44:50 +01:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: jCloud/jcloud-docsgen#76