Document and follow aliases better #414
Draft
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
added 2 commits
June 26, 2021 03:50
…l alias. An module-level alias must be defined at the top level of the module.
…fs blocks. Add a test for that.
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #414 +/- ##
==========================================
- Coverage 92.31% 92.20% -0.11%
==========================================
Files 45 46 +1
Lines 7959 8095 +136
Branches 1736 1767 +31
==========================================
+ Hits 7347 7464 +117
- Misses 356 370 +14
- Partials 256 261 +5 ☔ View full report in Codecov by Sentry. |
…computing it from AST all the time. Consider variables that are not on the root level as aliases, too. And warns only when they are actually overriden. Move node2fullname to astutils module. Delete overridenInCount from ClassPage since it was unused. Re-export names that are not part of the current system with an alias. Cleanup expandName() and associated. Use directly taglink() in format_alias_value() when possible. Add Documentable.aliases property. This is somewhat working in the tests but not always in real life. Rename the redirected_from parameter to "indirections". Speaking of tests, this commit also adds A LOT of new tests for the expandName() method.
…astbuilder tests, mostly related to alias handling... I'll fix that after merging.
|
Should undocumented aliases be shown in output ? I current implementation does, maybe we should think about it twice, because it cause create a lot of noise in the docs. |
tristanlatr
commented
Jun 11, 2022
| @@ -20,7 +20,7 @@ | |||
| <t:transparent t:render="functionBody"> | |||
| Docstring. | |||
| </t:transparent> | |||
| <t:transparent t:render="constantValue"> | |||
There was a problem hiding this comment.
This should not be change, i'll revert it to still be "constantValue".
Comment on lines
-358
to
+381
| def one(item: str) -> "Flattenable": | ||
| r: List['Flattenable'] = [] | ||
| for i, item in enumerate(lst): | ||
| if i>0: | ||
| r.append(', ') | ||
| if item in system.allobjects: | ||
| return tags.code(epydoc2stan.taglink(system.allobjects[item], page_url)) | ||
| r.append(tags.code(epydoc2stan.taglink(system.allobjects[item], page_url))) | ||
| else: | ||
| return item | ||
| def commasep(items: Sequence[str]) -> List["Flattenable"]: | ||
| r = [] | ||
| for item in items: | ||
| r.append(one(item)) | ||
| r.append(', ') | ||
| del r[-1] | ||
| return r | ||
| r.append(tags.code(item)) | ||
| p: List["Flattenable"] = [label] | ||
| p.extend(commasep(lst)) | ||
| p.extend(r) |
There was a problem hiding this comment.
Is this change necessary ?
Comment on lines
+10
to
+13
| # Dirty hack to work without the typing_extensions dep at runtime. | ||
| from collections import defaultdict | ||
| from functools import partial | ||
| Final = defaultdict(partial(defaultdict, defaultdict)) |
There was a problem hiding this comment.
Use 'Final' as string instead of doing that.
| class ModuleVistor(NodeVisitor): | ||
|
|
||
| def __init__(self, builder: 'ASTBuilder', module: model.Module): | ||
| super().__init__() | ||
| self.builder = builder | ||
| self.system = builder.system | ||
| self.module = module | ||
| self._moduleLevelAssigns: List[str] = [] |
There was a problem hiding this comment.
This looks like dead code, I'll remove it.
…d to _localNameToFullName() function.)
…he inventory. Goes much faster to test locally.
This was referenced Apr 4, 2024
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.
Add aliases to the output and add them in the system with a special kind:
ALIAS.This PR introduces major changes in the manner Documentable.expandName() processes the aliases.
Since we are now creating legit documentable object for every alias, the expandName() has to follow them.
See #313 for details.
TODO: