Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Regression bug from 0.1.13 to 0.2.x ? #33

Closed
felixchenier opened this issue Oct 9, 2020 · 3 comments · Fixed by #37
Closed

Regression bug from 0.1.13 to 0.2.x ? #33

felixchenier opened this issue Oct 9, 2020 · 3 comments · Fixed by #37

Comments

@felixchenier
Copy link

Hello

I have a problem with autodocsumm 1.2.x which generates a summary of all the module objects, (wrongly) including the imported objects. Also, the links between the summary table and the objects are not all created (some summary entries whose links worked before are not links at all in 1.2.x).

Reverting to 1.1.13 resolved the case for me.

I'm sorry I don't have a simple example project to reproduce the issue, but at least I'll initiate the bug report :-)

Don't hesitate if you're not able to reproduce the bug, I'll try to find time to build a simple projet.

Thank you anyways for this very helpful tool.

@Chilipp
Copy link
Owner

Chilipp commented Oct 9, 2020

Hey @felixchenier ! Thanks for reporting. Something must go won't with the following of members... It's likely also what causes the problem in #32, as the function that we talk about there is imported and actually would not have been listed...

I am using the same filtering as autodoc, but likely there has been introduced a bug in the last version, sorry. I need to have a closer look.

@bouweandela
Copy link

Note that the version numbers above and in the title are off by 1 in the major version number, it's 0.1.13 and 0.2.x

@Chilipp Chilipp mentioned this issue Dec 2, 2020
@felixchenier felixchenier changed the title Regression bug from 1.1.13 to 1.2.x ? Regression bug from 0.1.13 to 0.2.x ? Jan 8, 2021
@felixchenier
Copy link
Author

felixchenier commented Jan 8, 2021

Good morning Philipp

Thank you for working on this issue. I tried 0.2.2 today and I saw some difference but I don't think the issue is solved yet. Some imports such as imports from typing (Dict, Tuple, etc.) are correctly undocumented now, but some other imports (from my own libraries but also from other standard libraries such as copy) are. Also, I still get no link in the generated table.

I joined two screenshot to illustrate and maybe help you as much as I can. Both screenshots use the exact same configuration, but two different versions of autodocsumm. I hope it can be helpful.

Thank you again for the great work!

Felix

0.1.13 (please forgive the number inversion in the screenshot):
Screen Shot 2021-01-08 at 10 37 14

0.2.2:
Screen Shot 2021-01-08 at 10 33 59

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants