Added docstring about format of self.base_metadata dict

adsabs / ADSIngestParser

Curation parser library

MIT License

0 stars 7 forks source link

Added docstring about format of self.base_metadata dict #42

Closed kelockhart closed 1 year ago

kelockhart commented 1 year ago

All parsers parse into a temporary dictionary structure, usually named self.base_metadata. This temporary dictionary is then formatted using the format method on the base class. This PR adds documentation to the format method about the format it expects the temporary dictionary to be in.