Current TODO List

The following is an automatically generated list of TODO items from the source code.

The convention to mark a TODO item in the code is the # TODO: prefix, followed by HIGH, MED, LOW which is a very simple indicator of urgency.

  • HIGH are items that should be addressed by the next round of edits / release

  • MED are items that might require some form of re-design to be applied and require more long-term thinking.

  • LOW are items that would be good to have at some point in the future but are not immediately required to deliver a specific piece of functionality.

The following list has been produced by the doc/get_todos.sh script and is formatted in the standard egrep -Hn output format.

Specific Items

TODO List as of Fri May 19 12:32:47 UTC 2023
../citehound/plugin/plugin_manager.py:42 TODO: HIGH, must add more sanitation to a_plugin
../citehound/plugin/__init__.py:27 TODO: HIGH, enable the mandatory / optional value passing
../citehound/__init__.py:31 TODO: HIGH, Document these functions.
../citehound/__init__.py:79 TODO: HIGH, Raise exception as it is impossible to initialise the required objects
../citehound/__init__.py:97 TODO: MID, This could be parametrised with an abstract class to count specific objects.
../citehound/__init__.py:240 TODO: LOW, Can this be turned into some kind of map?
../citehound/__init__.py:268 TODO: HIGH, Turn this error into an exception
../citehound/datainput/ror.py:106 TODO: MEDIUM, Need to make sure that obsolete and redirected entries are handled appropriately.
../citehound/datainput/ror.py:108 TODO: LOW, Need to remove this extra try, catch which deals with this issue https://github.com/neo4j-contrib/neomodel/issues/303
../citehound/datainput/ror.py:162 TODO: LOW, Need to remove this extra try, catch which deals with this issue https://github.com/neo4j-contrib/neomodel/issues/303
../citehound/datainput/pubmed.py:50 TODO: HIGH, THIS QUERY NEEDS REVISION and to become parametrisable by the user
../citehound/datainput/pubmed.py:64 TODO: HIGH, Send this to the logging stream
../citehound/datainput/pubmed.py:88 TODO: MEDIUM, Affiliations might be more than one (?)
../citehound/datainput/pubmed.py:131 TODO: Low, Revise this for any better alternatives
../citehound/datainput/pubmed.py:154 TODO: LOW, Remove this double try once the problems with neomodel are fixed
../citehound/datainput/pubmed.py:173 TODO: HIGH, Remove the exterior list from the interior x["Affiliation"] once the code has been updated
../citehound/datainput/pubmed.py:220 TODO: HIGH, The XML reader can have an internal "skip" step to be moving automatically to the next item if an item does not satisfy an internal criterion as it happens with the pubmed filters here.
../citehound/datainput/mesh.py:22 TODO: Medium, needs tests.
../citehound/datainput/mesh.py:119 TODO: Medium, Needs testing.
../citehound/datainput/mesh.py:220 TODO: If treenumber_historic_index is not just one for a given code, then this should be an error condition
../citehound/datainput/mesh.py:232 TODO: LOW, This is a bit of a roundabout way of saving something that was a dictionary as a list only to immediatelly read it back and re-create the dictionary. Revise.
../citehound/datainput/grid.py:84 TODO: MEDIUM, Need to make sure that obsolete and redirected entries are handled appropriately.
../citehound/datainput/grid.py:86 TODO: LOW, Need to remove this extra try, catch which deals with this issue https://github.com/neo4j-contrib/neomodel/issues/303
../citehound/datainput/grid.py:119 TODO: LOW, Need to remove this extra try, catch which deals with this issue https://github.com/neo4j-contrib/neomodel/issues/303
../citehound/models/core.py:20 TODO: MED, This works for unweighted, propertyless edges that denote a simple association. But to denote that this edge is part of a graph, we need more information associated with this edge. If the edge model cannot be extended, this field should be turned into a JSON field with a given format.
../citehound/models/core.py:82 TODO: MED, Add //PubmedArticle[MedlineCitation/Article/AuthorList/Author[Identifier[@Source="ORCID"]]
../citehound/models/core.py:95 TODO: MED, Add //PubmedArticle[MedlineCitation/Article/AuthorList/Author[Identifier[@Source="ORCID"]]/AffiliationInfo/Identifier[@Source="GRID"]]
../citehound/batchprocess.py:90 TODO: MEDIUM, Relationships without data would lack a self._rel_data. But establishing it here would require an if on every "apply". So better split this into two classes