API Documentation Priority List

[michaelweinold]

brightway2-io

Priorities

symbol	description
1️⃣	high priority
2️⃣	medium priority
3️⃣	low priority
❌	deprecated
⏳	wait for strategic code changes

core modules (backup, etc.)

• 2️⃣ backup.py : Update docstrings to NumPy standards (export etc.) brightway2-io#169
• ❌ chemidplus.py
• 2️⃣ compatibility.py
• 2️⃣ download_utils.py: Update docstrings to NumPy standards (export etc.) brightway2-io#169
• 2️⃣ errors.py
• 2️⃣ utils.py: Update docstrings to NumPy standards (export etc.) brightway2-io#169
• 3️⃣ modified_database.py
• 3️⃣ package.py
• 3️⃣ errors.py
• 3️⃣ units.py
• 3️⃣ unlinked_data.py
• 3️⃣ utils.py

export

• 2️⃣ csv.py: Update docstrings to NumPy standards (export etc.) brightway2-io#169
• 2️⃣ excel.py: Update docstrings to NumPy standards (export etc.) brightway2-io#169
• 2️⃣ gexf.py: Update docstrings to NumPy standards (export etc.) brightway2-io#169
• 2️⃣ matlab.py: Update docstrings to NumPy standards (export etc.) brightway2-io#169

extractors

• 1️⃣ csv.py
• ❌ ecospold1.py: Update docstrings to NumPy standard (extractors/ecospold*, extractors/simapro*) brightway2-io#176
• ❌ ecospold1_lcia.py
• ❌ ecospold2.py
• 1️⃣ excel.py: Documentation improvements (extractors/excel) brightway2-io#182
• ⏳ exiobase.py
• 1️⃣ json_ld.py
• 1️⃣ simapro_csv.py
• 1️⃣ simapro_lcia_csv.py`

importers

• 1️⃣ base.py: Update docstrings to NumPy standard (importers) brightway2-io#172
• 1️⃣ base_lci.py
• 1️⃣ base_lcia.py
• ⏳ ecoinvent_lcia.py: Update docstrings to NumPy standard (importers) brightway2-io#166
• ⏳ ecospold1.py
• ⏳ ecospold1_lcia.py
• ⏳ ecospold2.py: Update docstrings to NumPy standard (importers) brightway2-io#172
• ⏳ ecospold2_biosphere.py: Update docstrings to NumPy standard (importers) brightway2-io#166
• 1️⃣ excel.py
• 2️⃣ excel_lcia.py: Update docstrings to NumPy standard (importers) brightway2-io#166
• ❌ exiobase3_hybrid.py
• ❌ exiobase3_monetary.py
• 2️⃣ json_ld.py
• 2️⃣ json_ld_lcia.py: Update docstrings to NumPy standard (importers) brightway2-io#166
• 2️⃣ simapro_csv.py
• 2️⃣ simapro_lcia_csv.py: Update docstrings to NumPy standard (importers) brightway2-io#166

strategies

• 1️⃣ biosphere.py
• 1️⃣ csv.py
• ❌ ecospold1.py
• ❌ ecospold1_allocation.py
• ❌ ecospold2.py: Update docstrings to NumPy standard (strategies/ecospold2) brightway2-io#175
• ❌ exiobase.py: Update docstrings to NumPy standard (strategies/exiobase) brightway2-io#177
• 1️⃣ generic.py: Documentation improvements (strategies/generic) brightway2-io#178
• 1️⃣ json_ld.py: Update docstrings to NumPy standard (strategies/json_ld) brightway2-io#180
• 1️⃣ json_ld_allocation.py
• 1️⃣ json_ld_lcia.py
• 1️⃣ lcia.py
• 1️⃣ locations.py
• 1️⃣ migrations.py
• 1️⃣ simapro.py
• 1️⃣ special.py
• 1️⃣ useeio.py