astropy / astropy/sphinx-automodapi

Duplicate member descriptions for ABC-derived classes are created.

Open
#60 12 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
67
Forks
48
Avg merge
11h 52m
Merged PRs (30d)
1

Description

It seems like the opposite effect of #52 is happening as of version 0.9: Class members for ABC-derived classes are displayed twice. Please refer to https://gitlab.com/picos-api/picos/issues/117 for a full issue description (I was about to post it here initially, but GitHub wouldn't let me upload the image).

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the full issue description in the linked GitLab issue and reproduce the behavior reported for version 0.9. Trace how the Sphinx extension generates member descriptions for ABC-derived classes. Done means those class members appear only once in the generated API documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.