Update handler for mkdocstrings 0.28#23
Conversation
|
Oh, let me fix linting. |
| try: | ||
| data = self.collect(identifier, {}) | ||
| except CollectionError: | ||
| return () | ||
| return data.path.as_posix(), *(p.signature.name for p in data.procedures) |
There was a problem hiding this comment.
I have replicated previous behavior here, but I have to note that this seems incorrect to return both the path of the file, as well as all the procedure names within it. It's possible that the previous method (get_anchors) was confusing, and the "anchors" concept not well explained. The renaming to get_aliases is to make it more clear: it's not really about HTML anchors, it's about obtaining all the different "aliases" ("locations") for a given object, to correctly populate mkdocs-autorefs data. I know nothing about VBA, but surely Procedure1 is not an alias of Procedure2?
Aliases (and the identifier) are supposed to be strings that you can pass to collect.
Here I'd either just return (data.path.as_posix(),) (or even an empty tuple ()), or add a way to support collecting Procedure1 without a file path (or these procedure objects should expose fully qualified names that can be collected).
There was a problem hiding this comment.
I will have to dig in and re-learn this code. A few years ago, I wrote the VBA handler by copying the Python handler and modifying it until it works. Even back then, I did not understand all the code. I'll try to go from this PR and see if I can build up a better understanding.
|
The rest of the Mypy warnings are irrelevant to this PR I believe. |
rudolfbyker
force-pushed
the
mkdocstrings-028
branch
from
be41bb4 to
99d3e6e
Compare
2 participants
Following discussion in mkdocstrings/mkdocstrings#727.