docs: improve documentation for utils and pipeline modules by Kaibalya-Mohanty · Pull Request #704 · kubeflow/kale

Kaibalya-Mohanty · 2026-03-17T15:56:15Z

Documentation Improvements

Improved docstrings for several utility functions:
- random_string
- abs_working_dir
- shorten_long_string
- dedent
- remove_ansi_color_sequences
- Added module-level documentation explaining pipeline architecture and execution flow:
- Enhanced add_step method docstring
- Added clearer explanations for pipeline structure and usage

These changes aim to improve clarity and onboarding for new contributors.

Looking forward to feedback!

Signed-off-by: KAIBALYA MOHANTY <168870673+Kaibalya-Mohanty@users.noreply.github.com>

ada333 · 2026-03-23T14:38:39Z

@Kaibalya-Mohanty Please do only DocString changes in this PR.

jesuino

Hello @Kaibalya-Mohanty

Thanks for your first contribution!

The documentation changes seems good and they are welcome! I notice that you possibly accidentally modified a function code. Would you please confirm if it was your goal to modify that or was it modified accidentally?

Thanks!

jesuino · 2026-05-27T14:27:50Z

-    """Remove ANSI color sequences from text."""
-    ansi_color_escape = re.compile(r"\x1B\[[0-9;]*m")
-    return ansi_color_escape.sub("", text)
+def remove_ansi_sequences(text: str) -> str:


I wonder if this change was expected. The function was renamed, but the reference to it in jputils.py was not updated. I would also not change the function implementation because the goal of your PR was to improve the documentation.

Thank you for the review. The function rename and implementation changes were unintentional. I have reverted the code changes and kept only the documentation improvements.

Reverted unintended function renaming and implementation changes. Kept only the docstring improvements for remove_ansi_color_sequences. Signed-off-by: KAIBALYA MOHANTY <168870673+Kaibalya-Mohanty@users.noreply.github.com>

ederign

@Kaibalya-Mohanty you are still making some code changes, can you please take a look? We will soon have more issues as well, check our issues backlog! Maybe you can find something more fun to work with!

ederign · 2026-06-30T12:45:35Z

Hi @Bagumeow, thanks for the contribution!

The CI failures are caused by this PR.

Signed-off-by: KAIBALYA MOHANTY <168870673+Kaibalya-Mohanty@users.noreply.github.com>

google-oss-prow · 2026-06-30T15:15:40Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from ederign. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Signed-off-by: KAIBALYA MOHANTY <168870673+Kaibalya-Mohanty@users.noreply.github.com>

Reverted broader ANSI regex, removed isinstance check, removed early-return guard in shorten_long_string, and removed added log.debug call in rm_r. Signed-off-by: KAIBALYA MOHANTY <168870673+Kaibalya-Mohanty@users.noreply.github.com>

Kaibalya-Mohanty · 2026-06-30T20:37:53Z

Hi, I've addressed both issues raised in the review:

Fixed the indentation errors in shorten_long_string and dedent
docstrings that were causing CI failures.
Separated the behavioral changes into a new PR fix: improve ANSI regex, add short-string guard, add debug logging in rm_r #864 to keep
this PR docs-only as suggested.

Please let me know if there's anything else to address. Thanks!

ederign · 2026-07-01T10:54:12Z

@ada333

ada333

LGTM

ederign

@Kaibalya-Mohanty those doc changes don't bring much value and we are in the third round of review and you still keep the behaviour changes.

ederign · 2026-07-01T11:52:07Z

            # the exception handler handle it (i.e., check ignore_missing etc.)
            raise OSError(errno.ENOENT, "No such file or directory", path)
    except OSError as e:
+        log.debug("Error while removing path: %s", path)


Still behaviour change.

ederign · 2026-07-01T11:52:16Z

+        Text with ANSI escape sequences removed.
+    """
+
+    ansi_escape = re.compile(


ederign · 2026-07-01T11:52:46Z

    str_input = str(obj)
-    return str_input[:chars] + " ..... " + str_input[len(str_input) - chars :]
+
+    return str_input[:chars] + " ..... " + str_input[-chars:]


These are NOT equivalent when chars=0:

utils.py

1a3466a

Signed-off-by: KAIBALYA MOHANTY <168870673+Kaibalya-Mohanty@users.noreply.github.com>

google-oss-prow Bot requested review from StefanoFioravanzo and ederign March 17, 2026 15:56

google-oss-prow Bot added the size/M label Mar 17, 2026

Update pipeline.py

1e47bb5

Signed-off-by: KAIBALYA MOHANTY <168870673+Kaibalya-Mohanty@users.noreply.github.com>

google-oss-prow Bot added size/L and removed size/M labels Mar 19, 2026

Kaibalya-Mohanty changed the title ~~Improved docstrings for several utility functions to enhance clarity and ease onboarding for new contributors.~~ docs: improve documentation for utils and pipeline modules Mar 19, 2026

Kaibalya-Mohanty mentioned this pull request Mar 19, 2026

chore: Better documentation of code #622

Closed

Kaibalya-Mohanty added 3 commits March 19, 2026 16:28

Update step.py

e2991b9

Signed-off-by: KAIBALYA MOHANTY <168870673+Kaibalya-Mohanty@users.noreply.github.com>

Update step.py

481e7d9

Signed-off-by: KAIBALYA MOHANTY <168870673+Kaibalya-Mohanty@users.noreply.github.com>

Refactor ANSI sequence removal function

6908579

Signed-off-by: KAIBALYA MOHANTY <168870673+Kaibalya-Mohanty@users.noreply.github.com>

jesuino requested changes May 27, 2026

View reviewed changes

google-oss-prow Bot assigned jesuino May 27, 2026

Revert unintended code changes in utils.py

498f1e7

Reverted unintended function renaming and implementation changes. Kept only the docstring improvements for remove_ansi_color_sequences. Signed-off-by: KAIBALYA MOHANTY <168870673+Kaibalya-Mohanty@users.noreply.github.com>

ederign requested changes Jun 27, 2026

View reviewed changes

google-oss-prow Bot assigned ederign Jun 27, 2026

This was referenced Jun 27, 2026

docs: improve documentation for Step class and execution logic #714

Closed

fix(utils): improve ANSI handling and logging debug information #720

Closed

Fix indentation in shorten_long_string and dedent docstrings

5acc677

Signed-off-by: KAIBALYA MOHANTY <168870673+Kaibalya-Mohanty@users.noreply.github.com>

Kaibalya-Mohanty added 2 commits June 30, 2026 22:48

Fix indentation in shorten_long_string and dedent docstrings

b4127a2

Signed-off-by: KAIBALYA MOHANTY <168870673+Kaibalya-Mohanty@users.noreply.github.com>

Revert behavior changes to keep PR docs-only

10f3aac

Reverted broader ANSI regex, removed isinstance check, removed early-return guard in shorten_long_string, and removed added log.debug call in rm_r. Signed-off-by: KAIBALYA MOHANTY <168870673+Kaibalya-Mohanty@users.noreply.github.com>

Kaibalya-Mohanty mentioned this pull request Jun 30, 2026

fix: improve ANSI regex, add short-string guard, add debug logging in rm_r #864

Closed

ada333 approved these changes Jul 1, 2026

View reviewed changes

google-oss-prow Bot assigned ada333 Jul 1, 2026

google-oss-prow Bot added the lgtm label Jul 1, 2026

ederign reviewed Jul 1, 2026

View reviewed changes

Uh oh!

Conversation

Kaibalya-Mohanty commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation Improvements

Uh oh!

ada333 commented Mar 23, 2026

Uh oh!

jesuino left a comment

Choose a reason for hiding this comment

Uh oh!

jesuino May 27, 2026

Choose a reason for hiding this comment

Uh oh!

Kaibalya-Mohanty Jun 3, 2026

Choose a reason for hiding this comment

Uh oh!

ederign left a comment

Choose a reason for hiding this comment

Uh oh!

ederign commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

google-oss-prow Bot commented Jun 30, 2026

Uh oh!

Kaibalya-Mohanty commented Jun 30, 2026

Uh oh!

ederign commented Jul 1, 2026

Uh oh!

ada333 left a comment

Choose a reason for hiding this comment

Uh oh!

ederign left a comment

Choose a reason for hiding this comment

Uh oh!

ederign Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

ederign Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

ederign Jul 1, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Kaibalya-Mohanty commented Mar 17, 2026 •

edited

Loading

ederign commented Jun 30, 2026 •

edited

Loading