From e91b7528a67c5813e706d4c26e6fa197bb34bb52 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20=C5=A0pl=C3=ADchal?= Date: Tue, 28 Nov 2023 15:47:00 +0100 Subject: [PATCH] Add a team report example using login aliases This use case has not been documented yet. Let's include at least a simple example demonstrating how the login aliases work. --- docs/config.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/config.rst b/docs/config.rst index 36404f0b..5036f067 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -78,6 +78,31 @@ This allows to override the default value for individual stats:: See :class:`did.base.User` for detailed information about the advanced email/login alias support. + +Team +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When multiple email addresses are provided in the config file, a +team report can be easily created as well:: + + [general] + email = + Petr Šplíchal ; github:psss; gitlab:psssssss, + Lukáš Zachar ; github:lukaszachy + + [github] + type = github + url = https://api.github.com/ + + [gitlab] + type = gitlab + url = https://gitlab.com + +Note in the example above that if user logins to be used in the +search query are different from the email address prefix you need +to specify them explicitly. + + Order ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~