aofarrel / glossarpy Goto Github PK

In definitions, I use [this] to signify an entry for that word exists. In RST mode that becomes an internal link. Unfortunately, ][a-zA-Z]+ (ie, ] followed by a letter, ex instructions in a Dockfile create [layer]s) breaks the resulting link. This seems to be a limitation of how RST works and not something I can fix without major hacks of our Sphinx setup.

Likely also affected:

• ][0-9]+
• [a-zA-Z][
• [0-9][

Current workaround is throw a warning at compile time in the ][a-zA-Z]+ case, which is much more likely then any of the other three listed above.

Punctuation and whitespace are not affected. [WDL]'s is fine, and so is [Seven Bridges].

(this ticket is a mirror of aofarrel/Dockstore-Dictionary#5)

mypy has to be run with --ignore-missing-imports as it cannot find the .pyi files it expects. Almost 100% chance I'm messing something up, not mypy. In any case, all types to get checked by mypy when it looks over the main python module, so this is acceptable for the time being.

This results in users having to do from glossarpy import glossarpy plus glossarpy.GlossEntry, which is a bit much.