From 981dedc148ad57c97d32bb687ee4d238a7a3bdd3 Mon Sep 17 00:00:00 2001 From: Daniel Huppmann Date: Tue, 8 Aug 2023 12:07:37 +0200 Subject: [PATCH] Extend the `Countries` docstring (#273) Co-authored-by: Philip Hackstock <20710924+phackstock@users.noreply.github.com> --- nomenclature/countries.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/nomenclature/countries.py b/nomenclature/countries.py index 1b36e259..a1f19a6a 100644 --- a/nomenclature/countries.py +++ b/nomenclature/countries.py @@ -42,7 +42,12 @@ class Countries(pycountry.ExistingCountries): - """List of countries based on ISO 3166 database with simplications""" + """List of countries based on simplified ISO 3166 database + + This list follows the :class:`nomenclature.countries` module based on + country names using ISO 3166-1, but it simplifies several country names + for readability and in line with conventions of the IAMC community. + """ def __init__(self): super().__init__(os.path.join(pycountry.DATABASE_DIR, "iso3166-1.json"))