Fixes for typedoc ~0.22.11 and strange self-referencing variable issue #189
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gabor-boros
reviewed
Feb 20, 2022
sphinx_js/typedoc.py
Outdated
Comment on lines
197
to
201
| def rec_helper(node): | ||
| if "sources" in node["__parent"]: | ||
| return node["__parent"]["sources"] | ||
| else: | ||
| rec_helper(node["__parent"]) |
There was a problem hiding this comment.
I know it is styling, but how about
Suggested change
| def rec_helper(node): | |
| if "sources" in node["__parent"]: | |
| return node["__parent"]["sources"] | |
| else: | |
| rec_helper(node["__parent"]) | |
| def rec_helper(node): | |
| if "sources" not in node["__parent"]: | |
| rec_helper(node["__parent"]) | |
| return node["__parent"]["sources"] |
There was a problem hiding this comment.
Come to think of it, there's an apparent bug in this code to start with. The recursive handling isn't returning at all-- this is getting ignored.
I pulled this from someone else's work. I'll modify it and see if anything changes.
Add ability to recognize literals as a type for TypeScript.
Kelketek
force-pushed
the
fox/STAR-2263-typedoc-name-fix
branch
from
8ae0efd
to
ebf7597
Compare
Kelketek
changed the title
tavianator
reviewed
Mar 14, 2022
Change the recursive function call to a while loop. Co-authored-by: Tavian Barnes <[email protected]>
tavianator
reviewed
Mar 14, 2022
sphinx_js/typedoc.py
Outdated
| @@ -328,6 +340,8 @@ def typedoc_output(abs_source_paths, sphinx_conf_dir, config_path): | |||
| with NamedTemporaryFile(mode='w+b') as temp: | |||
| command.add('--json', temp.name, *abs_source_paths) | |||
| try: | |||
| from pprint import pprint | |||
| pprint(command.make()) | |||
There was a problem hiding this comment.
Leftover debugging code?
tavianator
reviewed
Mar 14, 2022
Co-authored-by: Tavian Barnes <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This Pull request includes a fix from @semohr to resolve #166 and also resolves an issue that came up in this merge request where a node of type 'reference' did not exist in the index, but did have a 'name' key. This seems to be something that's cropped up in the new version of TypeDoc.
I've also added one additional change-- the ability to recognize literals as types for TypeDoc, so that things like null and 'name' or what have you don't show up as '<TODO: Other Type>'