:py:mod:`mass_driver.summarize`
===============================

.. py:module:: mass_driver.summarize

.. autodoc2-docstring:: mass_driver.summarize
   :parser: myst
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`group_by_outcome <mass_driver.summarize.group_by_outcome>`
     - .. autodoc2-docstring:: mass_driver.summarize.group_by_outcome
          :parser: myst
          :summary:
   * - :py:obj:`summarize_source <mass_driver.summarize.summarize_source>`
     - .. autodoc2-docstring:: mass_driver.summarize.summarize_source
          :parser: myst
          :summary:
   * - :py:obj:`summarize_migration <mass_driver.summarize.summarize_migration>`
     - .. autodoc2-docstring:: mass_driver.summarize.summarize_migration
          :parser: myst
          :summary:
   * - :py:obj:`summarize_forge <mass_driver.summarize.summarize_forge>`
     - .. autodoc2-docstring:: mass_driver.summarize.summarize_forge
          :parser: myst
          :summary:
   * - :py:obj:`print_prs <mass_driver.summarize.print_prs>`
     - .. autodoc2-docstring:: mass_driver.summarize.print_prs
          :parser: myst
          :summary:
   * - :py:obj:`summarize_result <mass_driver.summarize.summarize_result>`
     - .. autodoc2-docstring:: mass_driver.summarize.summarize_result
          :parser: myst
          :summary:
   * - :py:obj:`print_migration <mass_driver.summarize.print_migration>`
     - .. autodoc2-docstring:: mass_driver.summarize.print_migration
          :parser: myst
          :summary:
   * - :py:obj:`print_forge <mass_driver.summarize.print_forge>`
     - .. autodoc2-docstring:: mass_driver.summarize.print_forge
          :parser: myst
          :summary:

API
~~~

.. py:function:: group_by_outcome(result)
   :canonical: mass_driver.summarize.group_by_outcome

   .. autodoc2-docstring:: mass_driver.summarize.group_by_outcome
      :parser: myst

.. py:function:: summarize_source(result: mass_driver.models.repository.IndexedRepos, logger: logging.Logger)
   :canonical: mass_driver.summarize.summarize_source

   .. autodoc2-docstring:: mass_driver.summarize.summarize_source
      :parser: myst

.. py:function:: summarize_migration(result: mass_driver.models.activity.IndexedPatchResult, logger: logging.Logger, details: bool = True)
   :canonical: mass_driver.summarize.summarize_migration

   .. autodoc2-docstring:: mass_driver.summarize.summarize_migration
      :parser: myst

.. py:function:: summarize_forge(result: mass_driver.models.activity.IndexedPRResult, logger: logging.Logger, details: bool = True)
   :canonical: mass_driver.summarize.summarize_forge

   .. autodoc2-docstring:: mass_driver.summarize.summarize_forge
      :parser: myst

.. py:function:: print_prs(result: mass_driver.models.activity.IndexedPRResult, logger: logging.Logger)
   :canonical: mass_driver.summarize.print_prs

   .. autodoc2-docstring:: mass_driver.summarize.print_prs
      :parser: myst

.. py:function:: summarize_result(repos_by_outcome, activity_name, logger: logging.Logger)
   :canonical: mass_driver.summarize.summarize_result

   .. autodoc2-docstring:: mass_driver.summarize.summarize_result
      :parser: myst

.. py:function:: print_migration(repos_by_outcome, logger: logging.Logger)
   :canonical: mass_driver.summarize.print_migration

   .. autodoc2-docstring:: mass_driver.summarize.print_migration
      :parser: myst

.. py:function:: print_forge(repos_by_outcome, logger: logging.Logger)
   :canonical: mass_driver.summarize.print_forge

   .. autodoc2-docstring:: mass_driver.summarize.print_forge
      :parser: myst