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

add item even if it could not be imported #7948

Closed
wants to merge 1 commit into from

Conversation

Chilipp
Copy link

@Chilipp Chilipp commented Jul 13, 2020

partially reverts 1dcfc44 from #7661

Subject: Add an item to the autosummary table, even if it cannot be imported

Feature or Bugfix

  • Bugfix

Purpose

Not sure if this was removed by accident in #7661, but the following line has been removed in 1dcfc44

items.append((name, '', '', name))

I am readding it here and use the display_name instead of the name (makes more sense, doesn't it?). The reason, why I am interested in is, that otherwise instance attributes are skipped entirely with the autosummary directive.

Relates

Chilipp added a commit to Chilipp/autodocsumm that referenced this pull request Jul 13, 2020
@tk0miya tk0miya added this to the 3.2.0 milestone Jul 13, 2020
@tk0miya
Copy link
Member

tk0miya commented Jul 13, 2020

It's a main purpose of #7661, so this is expected. But I understand your case. So it would be better to improve autosummary in other way. I consider how to check the existence of instance attributes (without importing). So please wait for a whole.

@Chilipp
Copy link
Author

Chilipp commented Jul 13, 2020

I see. Thanks @tk0miya for this feedback. Shall I close this PR then and open an issue instead?

@tk0miya
Copy link
Member

tk0miya commented Jul 14, 2020

Yes, please.

@Chilipp
Copy link
Author

Chilipp commented Jul 27, 2020

closing this in favor of #8011

@Chilipp Chilipp closed this Jul 27, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 25, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants