[Bug 2138422] Re: Improve docstrings in UpdateManager/Core/utils.py (wrap, twrap, lsmod)

[Nathan Teodosio]

Hi Arnab, thanks for the contribution.

A couple of notes:

<<1<<

Prefer uploading a patch file instead of a copy of the file that is to
be changed. You say

> Attached: arnab-doc-patch.diff

but actually a copy of utils.py is attached.

Even better would be to submit a merge request to
https://code.launchpad.net/~ubuntu-core-dev/update-manager/+git/update-
manager/+ref/main.

<<2<<

The new docstring says

> (e.g., 'libssl1.1' could be split as 'libssl1.' on one line and '1' on
the next).

I think you mean libssl1-1.

<<3<<

There were functional changes resulting from replacing utils.py with
your copy. I do not know if this was intentional or because I placed
your file in a different branch than you did.

I trimmed down the docstrings changes to
https://git.launchpad.net/~nteodosio/update-
manager/commit/?id=5d4162c71fa3b07c633fe26d6325a9b4dbba214e. Can you
please check that is what you intended?

I can go ahead with a merge request for that, or you could do it
yourself (it would be nice to preserve your authorship in the author
field rather than in the commit message as I did).

What do you think?

** Changed in: update-manager (Ubuntu)
       Status: New => Triaged

** Changed in: update-manager (Ubuntu)
   Importance: Undecided => Wishlist

-- 
You received this bug notification because you are a member of Ubuntu
Foundations Bugs, which is subscribed to update-manager in Ubuntu.
https://bugs.launchpad.net/bugs/2138422

Title:
  Improve docstrings in UpdateManager/Core/utils.py (wrap, twrap, lsmod)

Status in update-manager package in Ubuntu:
  Triaged

Bug description:
  Hi,

  Improved docstrings in UpdateManager/Core/utils.py for better clarity:

  - wrap(): Explained why custom wrapper is needed (textwrap breaks package names on '-')
  - twrap(): Clarified multi-paragraph handling and use cases
  - lsmod(): Documented intentional return of [] on failure

  Pure documentation changes — no code changes, no behavior changes,
  safe for all users.

  Attached: arnab-doc-patch.diff

  Thanks!
  Arnab Patra

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/update-manager/+bug/2138422/+subscriptions