bugbug icon indicating copy to clipboard operation
bugbug copied to clipboard

Published 20 hours ago • verified publisher icon mozilla

added docstring to functions in bugzilla.py

Open skynette opened this issue 2 years ago • 5 comments

Description

This pull request adds missing docstrings to functions in bugzilla.py. Fixes #3360.

Changes Made Added docstrings to the following functions:

  • get_ids
  • get
  • get_ids_between
  • download_bugs
  • _find_linked
  • find_blocked_by
  • find_blocking
  • get_fixed_versions
  • delete_bugs
  • count_bugs
  • get_product_component_count
  • get_component_team_mapping
  • get_groups_users
  • get_revision_ids

skynette avatar Mar 16 '23 15:03 skynette

@suhaibmujahid review this, I'm I on track with this

skynette avatar Mar 16 '23 15:03 skynette

Thank you, @skynette!

Please consider the following:

  1. Get the latest commit from the master (rebase or merge) to get the docstrings linter. Then run the following and fix the errors: 
    pre-commit run pydocstyle --files bugbug/bugzilla.py
  2. Avoid the repetition (especially between the first line description and the return section).
  3. Where possible, describing the types should be using type hints, not in the docstrings.
  4. Follow Google Style Python Docstrings.

alright will do

skynette avatar Mar 20 '23 13:03 skynette

@suhaibmujahid please find the update PR in https://github.com/mozilla/bugbug/pull/3373

skynette avatar Mar 21 '23 23:03 skynette

@suhaibmujahid please find the update PR in #3373

Why did you open a duplicate PR? When you have an update, it should in the same PR.

Could you please close that PR and keep the work here?

suhaibmujahid avatar Mar 23 '23 00:03 suhaibmujahid

@suhaibmujahid please find the update PR in #3373

Why did you open a duplicate PR? When you have an update, it should in the same PR.

Could you please close that PR and keep the work here?

okay done that

skynette avatar Mar 23 '23 09:03 skynette