docs: added docstring to parse_xml module

main
Ricard Illa 2023-06-22 15:51:47 +02:00
parent b3069d4ca2
commit 691b8898a0
1 changed files with 10 additions and 0 deletions

View File

@ -1,3 +1,13 @@
"""Helper functions to parse the the raw_specifications xml string into a
dictionary containing the values we are interested in.
I decided to parse raw_speficications instead of using the "specifications"
column because the raw data seemed to be cleaner and more consistent, even if
it requires more effort to parse.
First I parse the xml into a dictionary. Then, I standardize the found keys into
some keys I expect.
"""
import logging
import xml.etree.ElementTree as ET