Skip to content

Commit

Permalink
Extend the Countries docstring (#273)
Browse files Browse the repository at this point in the history
Co-authored-by: Philip Hackstock <[email protected]>
  • Loading branch information
danielhuppmann and phackstock authored Aug 8, 2023
1 parent eaf2fae commit 981dedc
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion nomenclature/countries.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"))
Expand Down

0 comments on commit 981dedc

Please sign in to comment.