← All challenges
mediumsphinx-doc/sphinx · v5.0

inherited-members should support more than one class

docstoolingbase 7bdc11e87c
Mode

60 minutes, the full token budget.

  • Time limit60 min
  • Token budgetup to 1M
  • Worth up to210 XP

Opens VS Code with an AI agent in a new tab. Prompts, tokens, tool calls and test runs are recorded and scored.

Problem statement

Is your feature request related to a problem? Please describe.
I have two situations:

  • A class inherits from multiple other classes. I want to document members from some of the base classes but ignore some of the base classes
  • A module contains several class definitions that inherit from different classes that should all be ignored (e.g., classes that inherit from list or set or tuple). I want to ignore members from list, set, and tuple while documenting all other inherited members in classes in the module.

Describe the solution you'd like
The :inherited-members: option to automodule should accept a list of classes. If any of these classes are encountered as base classes when instantiating autoclass documentation, they should be ignored.

Describe alternatives you've considered
The alternative is to not use automodule, but instead manually enumerate several autoclass blocks for a module. This only addresses the second bullet in the problem description and not the first. It is also tedious for modules containing many class definitions.

The environment starts at commit 7bdc11e87c7d (sphinx-doc/sphinx 5.0), dependencies installed and tests runnable from the first minute. You are graded by hidden tests taken from the fix that was actually merged upstream.