Move utility functions out of the Python core package #72

Closed
opened 2026-10-21 12:42:19 +02:00 by jakob.scheid · 0 comments
Owner

Problem

The Python core package contains several utility functions that are not specific Python documentation. These are

  • _fit_row_length
  • _markdown_table

These functions are general utility functions. _fit_row_length fits the length of a table row into the expected length and _markdown_table generates a Markdown table. Both of them may also be required by documentation generators for other languages.

Goal

_fit_row_length and _markdown_table are located in the utility module. As they are no longer internal helper functions, their names do not contain trailing underscores.

## Problem The Python core package contains several utility functions that are not specific Python documentation. These are - `_fit_row_length` - `_markdown_table` These functions are general utility functions. `_fit_row_length` fits the length of a table row into the expected length and `_markdown_table` generates a Markdown table. Both of them may also be required by documentation generators for other languages. ## Goal `_fit_row_length` and `_markdown_table` are located in the utility module. As they are no longer internal helper functions, their names do not contain trailing underscores.
jakob.scheid added this to the 0.2.3 milestone 2026-10-21 12:42:19 +02:00
jakob.scheid added the
Priority
Medium
3
Compat/BreakingKind/Refactor
labels 2026-10-21 12:42:19 +02:00
jakob.scheid added this to the Project Board project 2026-10-21 12:42:19 +02:00
jakob.scheid moved this to To Do in Project Board on 2026-10-21 12:42:21 +02:00
jakob.scheid self-assigned this 2026-10-21 12:42:28 +02:00
jakob.scheid started working 2026-10-21 12:42:29 +02:00
jakob.scheid added reference refactor/restructure-general-utility-functions 2026-10-21 12:43:20 +02:00
jakob.scheid moved this to In progress in Project Board on 2026-10-21 12:43:22 +02:00
jakob.scheid added the
Reviewed
Confirmed
1
label 2026-10-21 12:43:26 +02:00
jakob.scheid moved this to Review in Project Board on 2026-10-21 13:08:49 +02:00
jakob.scheid worked for 27 minutes 2026-10-21 13:09:42 +02:00
jakob.scheid moved this to Done in Project Board on 2026-10-21 13:14:30 +02:00
Sign in to join this conversation.
1 Participants
Notifications
Total Time Spent: 27 minutes
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: jCloud/jcloud-docsgen#72