kallithea Files · docs/api/models.rst

Files @ 2d6ec8b9b633

Branch filter:

Location: kallithea/docs/api/models.rst

2d6ec8b9b633 632 B text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Thomas De Schampheleire

email templates: reorder references to pullrequests

The current references to PRs in email templates are:

Pull request from <repo> branch <branch> to <repo> branch <branch>:
<niceid> <title> by <user>

as the first line can become very long and therefore hard to read, a first
step is to introduce a newline before the destination branch:

Pull request from <repo> branch <branch>
to <repo> branch <branch>:
<niceid> <title> by <user>

But it would be nicer if the from/to part aligns more.
Moreover, the most useful part is (hopefully) the PR title, the from/to is
secondary and can sometimes even be inferred from the title and context the
recipient is already aware of.

Thus, this commit proposes the following format:

Pull request <niceid> <title> by <user>
from <repo> branch <branch>
to <repo> branch <branch>

This adds some divergence with the changeset references, which could be
aligned later if desired.

.. _models:

========================
The :mod:`models` module
========================

.. automodule:: kallithea.model
   :members:

.. automodule:: kallithea.model.comment
   :members:

.. automodule:: kallithea.model.notification
   :members:

.. automodule:: kallithea.model.permission
   :members:

.. automodule:: kallithea.model.repo_permission
   :members:

.. automodule:: kallithea.model.repo
   :members:

.. automodule:: kallithea.model.repo_group
   :members:

.. automodule:: kallithea.model.scm
   :members:

.. automodule:: kallithea.model.user
   :members:

.. automodule:: kallithea.model.user_group
   :members: