create_or_find_kernel_and_ramdisk inaccurately named

Bug #1840709 reported by Jeremy Freudberg on 2019-08-19
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
tripleo
Undecided
Jeremy Freudberg

Bug Description

After [0] merged, the function create_or_find_kernel_and_ramdisk is inaccurately named: there is no creation of images, only finding. Moreover its docstring refers to some arguments that have been removed.

[0] https://opendev.org/openstack/tripleo-common/src/commit/314917b2a9effbf26460ce6ca786362dd9dd2a4f/tripleo_common/utils/glance.py#L22

Recently these inaccuracies were a point of confusion for me. Perhaps the function should be renamed. I am personally able to at least contribute some docstring enhancements to make things a bit more clear and accurate. Reporting this so that the work can be tracked.

Changed in tripleo:
assignee: nobody → Jeremy Freudberg (jfreud)
tags: added: tripleo-common

Fix proposed to branch: master
Review: https://review.opendev.org/680116

Changed in tripleo:
status: New → In Progress

Reviewed: https://review.opendev.org/680116
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=07ead6bb2b1041ab1a446009977774b32c504a0c
Submitter: Zuul
Branch: master

commit 07ead6bb2b1041ab1a446009977774b32c504a0c
Author: Jeremy Freudberg <email address hidden>
Date: Wed Sep 4 14:17:29 2019 -0400

    create_or_find_kernel_and_ramdisk docstring fixes

    Some modest docstring fixes will serve to alleviate developer confusion
    (personally I have already been confused) as this function is no longer
    accurately named.

    Change-Id: If536f22755e24cdd67cbd83ac45fae69ed1c05b2
    Partial-Bug: #1840709

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers