ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-13 07:47:14 +03:00
Code Issues Projects Releases Wiki Activity

outfitting.py: Improve function docstrings

Browse Source
This commit is contained in:
Athanasius 2021-04-06 17:55:26 +01:00
parent c2a2377137
commit e7cb7dc34f
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
outfitting.py
View File

@ -44,9 +44,9 @@ def lookup(module, ship_map, entitled=False) -> Optional[dict]: # noqa: C901, C
Given the ad-hocery in this implementation a big lookup table might have been simpler and clearer.
:param module:
:param ship_map:
:param entitled:
:param module: module dict, e.g. from CAPI lastStarport->modules.
:param ship_map: dict mapping symbols to English names.
:param entitled: Whether to report modules that require e.g. Horizons.
:return: None if the module is user-specific (i.e. decal, paintjob, kit) or PP-specific in station outfitting.
"""
# Lazily populate
@ -257,7 +257,12 @@ def lookup(module, ship_map, entitled=False) -> Optional[dict]: # noqa: C901, C
def export(data, filename) -> None:
"""Export given data to provided filename."""
"""
Export given data about module availability.
:param data: CAPI data to export.
:param filename: Filename to export into.
"""
assert data['lastSystem'].get('name')
assert data['lastStarport'].get('name')