Refactor(utils): move general utility functions to utility module #73

2026-10-21T13:06:59+02:00

jakob.scheid commented

2026-10-21 13:06:59 +02:00

Move general utility functions to the utility module

This pull request moves the general utility functions _fit_row_length and _markdown_table from the Python documentation generator core module to the utility module. The trailing underscores were removed from their names as they are no longer internal functions of the Python documentation generator core module. All imports were updated and test files were moved the the appropriate new location. The testing functions were renamed to indicate that the utility functions are not internal.

Motivation

Those functions were general utility functions. They are not specific to the Python documentation generator and may also be required by documentation generators for other languages.

Related issues

Closes #72

# Move general utility functions to the utility module This pull request moves the general utility functions `_fit_row_length` and `_markdown_table` from the Python documentation generator core module to the utility module. The trailing underscores were removed from their names as they are no longer internal functions of the Python documentation generator core module. All imports were updated and test files were moved the the appropriate new location. The testing functions were renamed to indicate that the utility functions are not internal. ## Motivation Those functions were general utility functions. They are not specific to the Python documentation generator and may also be required by documentation generators for other languages. ## Related issues Closes #72

jakob.scheid added this to the 0.2.3 milestone 2026-10-21 13:06:59 +02:00

jakob.scheid added the

Priority

Medium

3

Compat/Breaking Kind/Refactor labels 2026-10-21 13:06:59 +02:00

jakob.scheid added this to the Project Board project 2026-10-21 13:06:59 +02:00

jakob.scheid added 2 commits 2026-10-21 13:07:00 +02:00

refactor(utils)!: move fit_row_length to utility module 36bc14185a

Moved the _fit_row_length function from the Python generator core module
to fit_row_length in the utility module. The public exports definition
of the utility module and all imports were updated.

The test module was also moved to the appropriate new path and the
testing functions were renamed.

refactor(utils)!: move markdown_table to utility module 6ddbd17497

Moved the markdown_table utility function from the Python documentation
generator core module to the utility module. The public exports
definition of the utility module and all imports were updated.

The test module was also moved to the appropriate new path and the
testing functions were renamed.

jakob.scheid moved this to Review in Project Board on 2026-10-21 13:08:47 +02:00

jakob.scheid merged commit b1727c100f into main

2026-10-21 13:14:27 +02:00

jakob.scheid deleted branch refactor/restructure-general-utility-functions

2026-10-21 13:14:27 +02:00

jakob.scheid moved this to Done in Project Board on 2026-10-21 13:14:31 +02:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: jCloud/jcloud-docsgen#73